DepictionEngine.Star Class Reference

A light source, and lens flare effect, emitting light in all directions. More...

Public Member Functions
override bool	RequiresPositioning ()
	Used to tell whether or not this object should be positioned in space according to its transform or kept to identity transform(origin) during origin shifting.
void	UpdateStar (Camera camera)
override bool	HierarchicalEndCameraRendering (Camera camera)
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the RenderPipelineManager.endCameraRendering.
override bool	PreHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
Public Member Functions inherited from DepictionEngine.GeoAstroObject
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
Grid2DIndexTerrainGridMeshObjects	GetGrid2DIndexTerrainGridMeshObject (int zoom, Vector2Int grid2DIndex)
bool	GetGeoCoordinateElevation (out float elevation, GeoCoordinate3Double geoCoordinate, Camera camera=null, bool raycast=false)
	The elevation value at a specific GeoCoordinate. The Elevation will be calculated from the elevation texture, if one is present, and will fallback to raycasting against the geometry of none is present.
Grid2DIndexTerrainGridMeshObjects	GetGrid2DIndexTerrainGridMeshObjectFromGeoCoordinate (GeoCoordinate3Double geoCoordinate, Camera camera=null)
bool	ContainsInitializedTerrainGridMeshObject ()
double	GetScaledRadius ()
double	GetScaledSize ()
void	SetSpherical (bool value, bool animate=true)
virtual float	GetSphericalRatio ()
bool	IsValidSphericalRatio ()
bool	IsSpherical ()
bool	IsFlat ()
double	GetScaledAtmosphereThickness ()
double	GetScale ()
double	GetCircumferenceAtLatitude (double latitude)
GeoCoordinate3Double	GetGeoCoordinateFromPoint (Vector3Double point)
GeoCoordinate3Double	GetGeoCoordinateFromLocalPoint (Vector3Double localPoint)
Vector3Double	GetPointFromGeoCoordinate (GeoCoordinate3Double geoCoordinate)
Vector3Double	GetLocalPointFromGeoCoordinate (GeoCoordinate3Double geoCoordinate)
Vector3Double	GetSurfacePointFromPoint (Vector3Double point, bool clamp=true)
Vector3Double	GetSurfaceLocalPointFromPoint (Vector3Double point, bool clamp=true)
QuaternionDouble	GetUpVectorFromPoint (Vector3Double point)
QuaternionDouble	GetUpVectorFromGeoCoordinate (GeoCoordinate2Double geoCoordinate)
override Vector3	GetGravitationalForce (Object objectBase)
override void	SetPlanetPreset (PlanetType astroObjectType)
double	GetAtmosphereThickness ()
double	GetAtmosphereAltitudeRatio (double atmosphereThickness, Vector3Double position)
RayDouble	GetGeoCoordinateRayDouble (GeoCoordinate3Double geoCoordinate)
RayDouble	GetGeoCoordinateRay (GeoCoordinate3Double geoCoordinate, double maxDistance)
double	GetDefaultRaycastMaxDistance ()
override bool	PostHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
bool	GetLoadingInitialized ()
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
Public Member Functions inherited from DepictionEngine.AstroObject
override bool	IsPhysicsObject ()
virtual void	SetPlanetPreset (PlanetType planet)
virtual Vector3	GetGravitationalForce (Object objectBase)
override bool	IsPhysicsObject ()
override bool	PostHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
Public Member Functions inherited from DepictionEngine.Object
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
override bool	UpdateRelations (Action beforeSiblingsInitializeCallback=null)
void	GetRequiredComponentTypes (ref List< Type > types)
override void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
virtual bool	RequiresPositioning ()
	Used to tell whether or not this object should be positioned in space according to its transform or kept to identity transform(origin) during origin shifting.
override bool	DetectUserGameObjectChanges ()
	Detect changes that happen as a result of an external influence.
virtual void	OnMouseMoveHit (RaycastHitDouble hit)
virtual void	OnMouseUpHit (RaycastHitDouble hit)
virtual void	OnMouseDownHit (RaycastHitDouble hit)
virtual void	OnMouseEnterHit (RaycastHitDouble hit)
virtual void	OnMouseExitHit (RaycastHitDouble hit)
virtual void	OnMouseClickedHit (RaycastHitDouble hit)
virtual int	GetAdditionalChildCount ()
virtual void	UpdateAdditionalChildren ()
Object	GetParentObject ()
	Use this is the Object may not be initialized at the moment and we cannot rely on transform.parentObject.
void	IterateOverChildrenObject (Func< Object, bool > callback)
	Use this if the Object may not be initialized at the moment and we cannot rely on transform.IterateOverChildren().
void	ApplyAutoAlignToSurface (LocalPositionParam localPositionParam, LocalRotationParam localRotationParam, GeoAstroObject parentGeoAstroObject, bool forceUpdate=false)
ReferenceBase	GetFirstReferenceOfType (string dataType)
void	SetParent (TransformBase parent, bool worldPositionStays=true)
void	IterateOverEffects< T > (Func< T, bool > callback)
void	IterateOverGenerators< T > (Func< T, bool > callback)
void	IterateOverReferences< T > (Func< T, bool > callback)
T	CreateScript< T > (InitializationContext initializingContext=InitializationContext.Programmatically)
T	CreateScript< T > (JSONObject json, InitializationContext initializingContext=InitializationContext.Programmatically)
Script	CreateScript (Type type, InitializationContext initializingContext=InitializationContext.Programmatically, bool isFallbackValues=false)
Script	CreateScript (Type type, JSONObject json, InitializationContext initializingContext=InitializationContext.Programmatically, bool isFallbackValues=false)
object	GetScriptProperty (IProperty property)
T	CreateChild< T > (string name=null, Transform parent=null, InitializationContext initializingContext=InitializationContext.Programmatically, List< PropertyModifier > propertyModifiers=null)
IScriptableBehaviour	CreateChild (Type type, string name=null, Transform parent=null, InitializationContext initializingContext=InitializationContext.Programmatically, List< PropertyModifier > propertyModifiers=null)
void	SetGridProperties (int loadScopeInstanceId, VisibleCameras visibleInCamerasInstanceId)
bool	CameraIsMasked (Camera camera)
virtual bool	IsPhysicsObject ()
virtual bool	IsPhysicsDriven ()
void	IterateOverReflectionProbes (Action< ReflectionProbe > callback)
void	UpdateReflectionProbe (out int added, out int removed)
	Automatically add the UnityEngine.ReflectionProbe(s) so the DepictionEngine.Object can manage them. When managed a 'customBakedTexture' will be generated, assigned and updated automatically for the UnityEngine.ReflectionProbe if their type is set to UnityEngine.Rendering.ReflectionProbeMode.Custom.
virtual bool	AddReflectionProbe (ReflectionProbe reflectionProbe)
	Add the UnityEngine.ReflectionProbe so the DepictionEngine.Object can manage it. When managed a 'customBakedTexture' will be generated, assigned and updated automatically for the UnityEngine.ReflectionProbe if their type is set to UnityEngine.Rendering.ReflectionProbeMode.Custom.
bool	RemoveReflectionProbe (ReflectionProbe reflectionProbe)
	Remove the UnityEngine.ReflectionProbe from the managed list.
virtual bool	IsReflectionObject ()
bool	ReflectionRequiresRender (out Camera camera)
void	UpdateEnvironmentReflection (RTTCamera rttCamera, Camera camera, ScriptableRenderContext? context=null)
override bool	PreHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
override bool	PostHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
void	ClearForceUpdateTransformPending (bool clearLocalPosition=false, bool clearLocalRotation=false, bool clearLocalScale=false)
void	ForceUpdateTransformPending (bool localPositionChanged=false, bool localRotationChanged=false, bool localScaleChanged=false)
void	ForceUpdateTransformIfPending ()
bool	ForceUpdateTransform (bool localPositionChanged=false, bool localRotationChanged=false, bool localScaleChanged=false, Camera camera=null)
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
Public Member Functions inherited from DepictionEngine.PersistentMonoBehaviour
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
override bool	DetectUserGameObjectChanges ()
	Detect changes that happen as a result of an external influence.
int	Save ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.
int	Synchronize ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.
int	Delete ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
override void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
virtual bool	DetectUserGameObjectChanges ()
	Detect changes that happen as a result of an external influence.
Public Member Functions inherited from DepictionEngine.PropertyMonoBehaviour
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
override void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
virtual void	UpdateDependencies ()
virtual bool	UpdateRelations (Action beforeSiblingsInitializeCallback=null)
virtual void	UpdateParent (PropertyMonoBehaviour originator=null)
	Finds and sets the parent.
bool	PropertyDirty (string name)
void	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.
void	UpdateActiveAndEnabled ()
virtual void	HierarchicalApplyOriginShifting (Vector3Double origin, bool originShiftSelected)
virtual bool	HierarchicalBeginCameraRendering (Camera camera)
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the RenderPipelineManager.beginCameraRendering.
virtual bool	HierarchicalEndCameraRendering (Camera camera)
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the RenderPipelineManager.endCameraRendering.
virtual bool	PreHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
virtual void	PreHierarchicalUpdateBeforeChildrenAndSiblings ()
virtual bool	HierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.PreHierarchicalUpdate and before the DepictionEngine.PropertyMonoBehaviour.PostHierarchicalUpdate.
virtual bool	PostHierarchicalUpdate ()
	Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called after the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.
virtual void	IterateOverChildrenAndSiblings (Action< PropertyMonoBehaviour > callback=null)
override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
Public Member Functions inherited from DepictionEngine.MonoBehaviourDisposable
virtual void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
bool	Initialize ()
	Needs to be called before the object can be used. Objects created through the DepictionEngine.InstanceManager should automatically Initialize the object.
virtual void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
T	AddComponent< T > (InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)
T	AddComponent< T > (bool initialize, InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)
Component	AddComponent (Type componentType, InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)
Component	AddComponent (Type componentType, bool initialize, InitializationContext initializingContext=InitializationContext.Programmatically, JSONObject json=null, List< PropertyModifier > propertyModifiers=null, bool isFallbackValues=false)
InitializationContext	GetInitializeContext ()
bool	IsDisposing ()
	Is the object disposing?.
bool	IsDisposed ()
	Has the object been disposed?
void	Originator (Action callback, IScriptableBehaviour originator)
	Provides the code executed in this callback information about the DepictionEngine.IScriptableBehaviour that triggered it by keeping a reference available under DepictionEngine.IScriptableBehaviour.originator.
bool	OnDisposing ()
bool	UpdateDisposingContext (bool forceUpdate=false)
	This is where you clear or dispose any remaining references. It will be called automatically by DepictionEngine.DisposeManager immediately after DepictionEngine.IDisposable.OnDisposing unless the object was Destroyed as a result of an Editor action.
void	OnDisposeInternal (DisposeContext disposeContext)
virtual bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
void	OnDestroy ()
	This is where you destroy any remaining dependencies.
virtual void	OnBeforeSerialize ()
virtual void	OnAfterDeserialize ()
virtual void	OnValidate ()
bool	Equals (Disposable.Null value)
override bool	Equals (object value)
override int	GetHashCode ()
Public Member Functions inherited from DepictionEngine.IScriptableBehaviour
InitializationContext	GetInitializeContext ()
void	Originator (Action callback, IScriptableBehaviour originator)
	Provides the code executed in this callback information about the DepictionEngine.IScriptableBehaviour that triggered it by keeping a reference available under DepictionEngine.IScriptableBehaviour.originator.
int	GetInstanceID ()
void	OnDestroy ()
	This is where you destroy any remaining dependencies.
void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.
void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.
bool	Initialize ()
	Needs to be called before the object can be used. Objects created through the DepictionEngine.InstanceManager should automatically Initialize the object.
bool	IsDisposing ()
	Is the object disposing?.
bool	IsDisposed ()
	Has the object been disposed?
bool	OnDisposing ()
bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.
void	OnDisposeInternal (DisposeContext disposeContext)
bool	UpdateDisposingContext (bool forceUpdate=false)
	This is where you clear or dispose any remaining references. It will be called automatically by DepictionEngine.DisposeManager immediately after DepictionEngine.IDisposable.OnDisposing unless the object was Destroyed as a result of an Editor action.
bool	Equals (Disposable.Null value)
void	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.
int	Save ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.
int	Synchronize ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.
int	Delete ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.
void	GetRequiredComponentTypes (ref List< Type > types)

Protected Member Functions
override void	CreateAndInitializeDependencies (InitializationContext initializingContext)
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
Protected Member Functions inherited from DepictionEngine.GeoAstroObject
override bool	InitializeLastFields ()
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
override bool	UpdateAllDelegates ()
	Function to initialize event handlers.
override void	InstanceAddedHandler (IProperty property)
Protected Member Functions inherited from DepictionEngine.AstroObject
override double	GetDefaultMass ()
override bool	ResetTransform ()
Vector3	GetGravitationalForce (Object objectBase, double distance, Vector3Double direction)
Protected Member Functions inherited from DepictionEngine.DatasourceRoot
override bool	TransformObjectCallback (LocalPositionParam localPositionParam, LocalRotationParam localRotationParam, LocalScaleParam localScaleParam, Camera camera=null)
virtual bool	ResetTransform ()
Protected Member Functions inherited from DepictionEngine.Object
override void	IterateOverComponentReference (Action< SerializableGuid, Action > callback)
override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
override void	DestroyAfterFailedInitialization ()
override bool	InitializeLastFields ()
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
T	CreateOptionalProperties< T > (InitializationContext initializingContext)
override bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.
override void	CreateAndInitializeDependencies (InitializationContext initializingContext)
void	UpdateRigidbody ()
Component	RemoveComponentFromList (Type type, Component[] components)
override bool	IsValidInitialization (InitializationContext initializingContext)
	Provides the ability to interrupt the initialization.
override bool	LateInitialize (InitializationContext initializingContext)
	Every other objects are initialized at this point.
virtual double	GetDefaultMass ()
virtual bool	CanBeDuplicated ()
	Can the UnityEngine.Object be duplicated.
override bool	UpdateAllDelegates ()
	Function to initialize event handlers.
virtual bool	AddInputManagerDelegates ()
virtual void	InputManagerOnMouseClickedHandler (RaycastHitDouble hit)
virtual void	RemoveTransformDelegate (TransformBase transform)
virtual void	AddTransformDelegate (TransformBase transform)
virtual bool	TransformChanged (TransformBase.Component changedComponent, TransformBase.Component capturedComponent)
virtual void	TransformPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)
virtual void	ScriptPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)
bool	RemoveLoadScopeDataReferenceDelegate (ReferenceBase reference)
bool	AddLoadScopeDataReferenceDelegate (ReferenceBase reference)
virtual bool	UpdateReferences (bool forceUpdate=false)
T	GetAssetFromAssetReference< T > (AssetReference assetReference)
virtual bool	IterateOverAssetReferences (Func< AssetBase, AssetReference, bool, bool > callback)
virtual void	ReferenceLoaderPropertyAssignedChangedHandler (ReferenceBase reference, IProperty serializable, string name, object newValue, object oldValue)
virtual void	TransformChildAddedHandler (TransformBase transform, PropertyMonoBehaviour child)
virtual void	TransformChildRemovedHandler (TransformBase transform, PropertyMonoBehaviour child)
virtual void	TransformChildPropertyChangedHandler (TransformBase transform, string name, object newValue, object oldValue)
void	ChildObjectPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)
void	TransformObjectCallbackHandler (LocalPositionParam localPositionParam, LocalRotationParam localRotationParam, LocalScaleParam localScaleParam, Camera camera=null)
virtual bool	TransformObjectCallback (LocalPositionParam localPositionParam, LocalRotationParam localRotationParam, LocalScaleParam localScaleParam, Camera camera=null)
virtual bool	RemoveParentGeoAstroObjectDelegate (GeoAstroObject parentGeoAstroObject)
virtual bool	AddParentGeoAstroObjectDelegate (GeoAstroObject parentGeoAstroObject)
virtual void	ParentGeoAstroObjectPropertyAssignedHandler (IProperty property, string name, object newValue, object oldValue)
virtual void	ParentGeoAstroObjectChanged (GeoAstroObject newValue, GeoAstroObject oldValue)
override bool	IsFullyInitialized ()
override Type	GetParentType ()
override Type	GetSiblingType ()
override bool	SiblingsHasChanged ()
override bool	GetDontSaveToScene ()
virtual bool	GetDefaultIsHiddenInHierarchy ()
virtual bool	CanGameObjectBeDeactivated ()
virtual bool	SetController (ControllerBase value)
void	InitializeReferenceDataType (string dataType, Type referenceType=null)
override bool	SetParent (PropertyMonoBehaviour value)
virtual bool	SetTargetController (TargetControllerBase value)
virtual bool	SetTransform (TransformDouble value)
int	GetScriptCount ()
void	IterateOverComponents (Action< PropertyMonoBehaviour > callback)
override bool	AddChild (PropertyMonoBehaviour child)
virtual bool	AddScript (Script script)
virtual bool	AddGenerator (GeneratorBase generator)
virtual bool	AddReference (ReferenceBase reference)
virtual bool	AddFallbackValues (FallbackValues fallbackValue)
override bool	RemoveChild (PropertyMonoBehaviour child)
virtual bool	RemoveScript (Script script)
virtual bool	RemoveGenerator (GeneratorBase generator)
virtual bool	RemoveReference (ReferenceBase reference)
bool	RemoveFallbackValues (FallbackValues fallbackValue)
virtual void	VisibleCamerasChanged ()
virtual void	GetReflectionProbes (ref List< ReflectionProbe > managedReflectionProbes)
void	RegisterWithRenderingManager ()
virtual void	UpdateReflectionCustomBakedTexture (int textureSize)
virtual bool	GetReflectionRenderCamera (out Camera camera)
virtual int	GetReflectionTextureSize ()
virtual void	RenderToReflectionCubemap (RTTCamera rttCamera, Camera camera)
override bool	ApplyBeforeChildren (Action< PropertyMonoBehaviour > callback)
override bool	UpdateHideFlags ()
void	DisposeDataProcessor (Processor dataProcessor)
override void	ActiveAndEnabledChanged (bool newValue, bool oldValue)
virtual bool	DisposeAllChildren (DisposeContext disposeContext=DisposeContext.Programmatically_Pool)
	Dispose all children visuals.
Protected Member Functions inherited from DepictionEngine.PersistentMonoBehaviour
override bool	InitializeLastFields ()
override bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.
override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
override void	Saving (Scene scene, string path)
override bool	UpdateHideFlags ()
virtual bool	GetDefaultDontSaveToScene ()
virtual bool	GetDontSaveToScene ()
Protected Member Functions inherited from DepictionEngine.JsonMonoBehaviour
override void	Initializing ()
	The first step of the initialization process.
virtual JSONObject	GetInitializationJson (JSONObject initializeJSON)
override bool	InitializeLastFields ()
override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
override SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)
virtual void	EnabledChanged (bool newValue, bool oldValue)
Protected Member Functions inherited from DepictionEngine.PropertyMonoBehaviour
virtual void	IterateOverComponentReference (Action< SerializableGuid, Action > callback)
override void	Initializing ()
	The first step of the initialization process.
override void	InitializeUID (InitializationContext initializingContext)
	Initializes the object's unique identifiers.
virtual SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)
override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
virtual void	InitializeFieldsBeforeChildren (InitializationContext initializingContext)
virtual void	InitializeSerializedFieldsBeforeChildren (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
virtual void	CreateAndInitializeDependencies (InitializationContext initializingContext)
virtual void	InitializeFields (InitializationContext initializingContext)
virtual void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.
virtual bool	InitializeLastFields ()
virtual bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.
override bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.
override bool	UpdateAllDelegates ()
	Function to initialize event handlers.
virtual void	InstanceAddedHandler (IProperty property)
virtual void	InstanceRemovedHandler (IProperty property)
virtual bool	RemoveParentDelegates (PropertyMonoBehaviour parent)
virtual bool	AddParentDelegates (PropertyMonoBehaviour parent)
virtual bool	RemoveChildDelegates (PropertyMonoBehaviour child)
virtual bool	AddChildDelegates (PropertyMonoBehaviour child)
virtual PropertyMonoBehaviour	GetParent ()
void	UpdateSiblings ()
virtual void	UpdateChildren ()
T	InitializeComponent< T > (T component, JSONObject json=null, bool isFallbackValues=false)
virtual bool	ParentHasChanged ()
virtual bool	SiblingsHasChanged ()
virtual bool	ChildrenHasChanged ()
List< T >	GetComponentFromId< T > (List< SerializableGuid > ids)
T	GetComponentFromId< T > (SerializableGuid id)
List< SerializableGuid >	GetDuplicateComponentReferenceId< T > (List< SerializableGuid > ids, List< T > componentReferences, InitializationContext initializingContext)
SerializableGuid	GetDuplicateComponentReferenceId< T > (SerializableGuid id, T componentReference, InitializationContext initializingContext)
virtual bool	SetValue< T > (string name, T value, ref T valueField, Action< T, T > assignedCallback=null, bool allowAutoDisposeOnOutOfSynchProperty=false)
bool	HasChanged< T > (T newValue, T oldValue, bool forceChangeDuringInitializing=true)
	Are the two objects equals?
void	PropertyAssigned< T > (IProperty property, string name, T newValue, T oldValue)
virtual Type	GetParentType ()
virtual Type	GetSiblingType ()
virtual Type	GetChildType ()
virtual bool	CanBeDisabled ()
override void	OnDisable ()
override void	OnEnable ()
virtual void	ActiveAndEnabledChanged (bool newValue, bool oldValue)
virtual PropertyMonoBehaviour	GetRootParent ()
virtual PropertyMonoBehaviour	ValidatedParent (PropertyMonoBehaviour value)
virtual bool	SetParent (PropertyMonoBehaviour value)
virtual void	ParentChanged (PropertyMonoBehaviour newValue, PropertyMonoBehaviour oldValue)
virtual bool	AddChild (PropertyMonoBehaviour child)
virtual bool	RemoveChild (PropertyMonoBehaviour child)
virtual bool	ApplyBeforeChildren (Action< PropertyMonoBehaviour > callback)
virtual void	IterateOverChildren (Action< PropertyMonoBehaviour > callback=null)
bool	RemoveListItem< T > (List< T > list, T property)
void	IterateThroughList< T > (IList< T > list, Action< T > callback)
virtual bool	ApplyAfterChildren (Action< PropertyMonoBehaviour > callback)
bool	TriggerCallback< T > (T child, Action< T > callback)
virtual void	ClearDirtyFlags ()
Protected Member Functions inherited from DepictionEngine.MonoBehaviourDisposable
virtual void	Awake ()
bool	IsDuplicateInitializing ()
virtual void	DestroyAfterFailedInitialization ()
virtual void	Initializing ()
	The first step of the initialization process.
virtual void	InitializeUID (InitializationContext initializingContext)
	Initializes the object's unique identifiers.
virtual bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.
virtual bool	Initialize (InitializationContext initializingContext)
	The main initialization function.
virtual bool	IsValidInitialization (InitializationContext initializingContext)
	Provides the ability to interrupt the initialization.
bool	InitValue< T > (Action< T > callback, T defaultValue, InitializationContext initializingContext)
bool	InitValue< T > (Action< T > callback, T defaultValue, Func< T > duplicateValue, InitializationContext initializingContext)
virtual bool	IsFullyInitialized ()
virtual bool	UpdateAllDelegates ()
	Function to initialize event handlers.
virtual void	Saving (UnityEngine.SceneManagement.Scene scene, string path)
virtual void	Saved (UnityEngine.SceneManagement.Scene scene)
virtual bool	LateInitialize (InitializationContext initializingContext)
	Every other objects are initialized at this point.
virtual bool	PostLateInitialize (InitializationContext initializingContext)
	Every other objects are initialized at this point.
bool	IsFallbackValues ()
bool	IsNotFallbackValues ()
bool	IsDestroying ()
	Is the object destroying?
virtual bool	UpdateHideFlags ()
virtual DisposeContext	GetDisposingContext ()
virtual void	OnEnable ()
virtual void	OnDisable ()

Properties
Color	color [get, set]
	The color of the light.
float	lensFlareScale [get, set]
	A multiplier used to increase the size of the lens flare.
float	intensity [get, set]
	The intensity of a light is multiplied with the Light color.
float	range [get, set]
	The range of the light.
LightShadows	shadows [get, set]
	How this light casts shadows.
bool	useOcclusion [get, set]
	When enabled, raycasting is used to (partially or completely) occlude the lens flare.
float	occlusionRadius [get, set]
	Sets a radius multiplier around the light used to calculate the occlusion of the lens flare. If this area is half occluded by geometry, the intensity of the lens flare is cut by half.
uint	occlusionSampleCount [get, set]
	Sets the number of random samples used inside the Occlusion Radius area. A higher sample count gives a smoother attenuation when occluded.
Properties inherited from DepictionEngine.GeoAstroObject
double	radius [get]
double	size [get, set]
	The size (Circumference in spherical mode or width in flat mode), in world units.
float	sphericalDuration [get, set]
	The amount of time required for the DepictionEngine.GeoAstroObject to transition from spherical to flat.
bool	spherical [get, set]
	Display as a sphere (true) or flat (false)?
float	sphericalRatio [get]
float	seaLevel [get, set]
	The amount of time required for the DepictionEngine.GeoAstroObject to transition from spherical to flat.
Properties inherited from DepictionEngine.Object
GeoAstroObject	parentGeoAstroObject [get]
ObjectAdditionalFallbackValues	objectAdditionalFallbackValues [get, set]
bool	gameObjectActiveSelf [get, set]
	ActivatesDeactivates the GameObject, depending on the given true or false/ value.
string	tags [get, set]
	General purpose metadata associated with the object, used for searching or otherwise.
bool	useGravity [get, set]
	When enabled, the GameObject will automatically reacts to DepictionEngine.AstroObject gravitational pull based on DepictionEngine.Object.mass and DepictionEngine.AstroObject.mass.
double	mass [get, set]
	Used to determine the amount of gravitational force to apply when DepictionEngine.Object.useGravity is enabled.
int	layer [get, set]
	The layer the GameObject is in.
new string	tag [get, set]
	The tag of this GameObject.
bool	isHiddenInHierarchy [get, set]
	When enabled, the UnityEngine.GameObject will not be displayed in the hierarchy.
bool	createAnimatorIfMissing [get, set]
	When enabled, a new DepictionEngine.AnimatorBase will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
SerializableGuid	animatorId [get, set]
	The Id of the animator.
bool	createControllerIfMissing [get, set]
	When enabled, a new DepictionEngine.ControllerBase will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
SerializableGuid	controllerId [get, set]
	The Id of the controller.
bool	createGeneratorIfMissing [get, set]
	When enabled, a new DepictionEngine.GeneratorBase will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
List< SerializableGuid >	generatorsId [get, set]
	The Id of the generators.
bool	createReferenceIfMissing [get, set]
	When enabled, a new DepictionEngine.ReferenceBase will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
List< SerializableGuid >	referencesId [get, set]
	The Id of the references.
bool	createEffectIfMissing [get, set]
	When enabled, a new DepictionEngine.EffectBase will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
List< SerializableGuid >	effectsId [get, set]
	The Id of the effects.
bool	createFallbackValuesIfMissing [get, set]
	When enabled, a new DepictionEngine.FallbackValues will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
List< SerializableGuid >	fallbackValuesId [get, set]
	The Id of the fallbackValues.
bool	createDatasourceIfMissing [get, set]
	When enabled, a new DepictionEngine.DatasourceBase will be created if none is present in the DepictionEngine.IPersistent returned from the datasource.
List< SerializableGuid >	datasourcesId [get, set]
	The Id of the datasources.
AnimatorBase	animator [get]
	The DepictionEngine.AnimatorBase used by this object.
ControllerBase	controller [get]
	The DepictionEngine.ControllerBase used by this object.
List< GeneratorBase >	generators [get]
	A list of DepictionEngine.GeneratorBase used by this object.
List< ReferenceBase >	references [get]
	A list of DepictionEngine.ReferenceBase used by this object.
List< EffectBase >	effects [get]
	A list of DepictionEngine.EffectBase used by this object.
List< FallbackValues >	fallbackValues [get]
	A list of DepictionEngine.FallbackValues used by this object.
List< DatasourceBase >	datasources [get]
	A list of DepictionEngine.DatasourceBase used by this object.
TargetControllerBase	targetController [get, set]
new TransformDouble	transform [get, protected set]
int	reflectionProbeCount [get]
List< ReflectionProbe >	managedReflectionProbes [get, set]
RenderTexture	reflectionCustomBakedTexture [get]
ComponentChangedPending	forceUpdateTransformPending [get]
Properties inherited from DepictionEngine.PersistentMonoBehaviour
Action< IPersistent, Action >	PersistenceSaveOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.
Action< IPersistent, Action >	PersistenceSynchronizeOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.
Action< IPersistent, Action >	PersistenceDeleteOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.
new string	name [get, set]
	The name of the object.
float	autoSynchronizeInterval [get, set]
	The interval (in seconds) at which we call the DepictionEngine.IPersistent.Synchronize function. Automatically calling DepictionEngine.IPersistent.Synchronize can be useful to keep objects in synch with a datasource. Set to zero to deactivate.
bool	autoDispose [get, set]
	When enabled, the object can be disposed automatically by its datasource if it is no longer required in any loader and does not have any out of synch properties.
bool	dontSaveToScene [get, set]
	When enabled, the object will not be saved as part of the Scene.
bool	createPersistentIfMissing [get, set]
	When enabled, a new DepictionEngine.IPersistent will be created if none is present in the datasource.
bool	containsCopyrightedMaterial [get]
	Whether or not the object contains data that is copyrighted. If true the object may not be persisted in a Scene or DepictionEngine.Datasource.
Properties inherited from DepictionEngine.JsonMonoBehaviour
JSONNode	initializationJson [get]
new bool	enabled [get, set]
	Enabled Behaviours are Updated, disable Behaviours are not.
Properties inherited from DepictionEngine.PropertyMonoBehaviour
Type	type [get]
	The Cass type.
List< PropertyMonoBehaviour >	children [get]
Action< IProperty, string, object, object >	PropertyAssignedEvent [get, set]
	Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.
SerializableGuid	id [get]
	Global unique identifier.
bool	activeAndEnabled [get]
	Returns true if gameObject.activeInHierarchy == true and enabled == true.
PropertyMonoBehaviour	parent [get, set]
	The object above in the hierarchy.
virtual JSONNode	parentJson [get, set]
Properties inherited from DepictionEngine.MonoBehaviourDisposable
bool	wasFirstUpdated [get]
bool	initialized [get]
	Has the object been initialized.
bool	instanceAdded [get, set]
bool	isFallbackValues [get]
	Was this component created by a DepictionEngine.FallbackValues.
IScriptableBehaviour	originator [get]
	Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.
DisposeContext	disposingContext [get]
	The DepictionEngine.DisposeContext under which the object was destroyed.
bool	poolComplete [get, set]
	Is the object done disposing.
Action< IDisposable >	InitializedEvent [get, set]
	Dispatched after the object as been initialized.
Action< IDisposable, DisposeContext >	DisposedEvent [get, set]
	Dispatched during the DepictionEngine.MonoBehaviourDisposable.OnDispose, DepictionEngine.ScriptableObjectDisposable.OnDispose or DepictionEngine.Disposable.OnDispose.
SceneManager	sceneManager [get]
InstanceManager	instanceManager [get]
DatasourceManager	datasourceManager [get]
TweenManager	tweenManager [get]
InputManager	inputManager [get]
CameraManager	cameraManager [get]
PoolManager	poolManager [get]
RenderingManager	renderingManager [get]
Properties inherited from DepictionEngine.IScriptableBehaviour
string	name [get, set]
bool	isFallbackValues [get]
	Was this component created by a DepictionEngine.FallbackValues.
IScriptableBehaviour	originator [get]
	Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.
Properties inherited from DepictionEngine.IDisposable
Action< IDisposable >	InitializedEvent [get, set]
	Dispatched after the object as been initialized.
Action< IDisposable, DisposeContext >	DisposedEvent [get, set]
	Dispatched during the DepictionEngine.MonoBehaviourDisposable.OnDispose, DepictionEngine.ScriptableObjectDisposable.OnDispose or DepictionEngine.Disposable.OnDispose.
bool	initialized [get]
	Has the object been initialized.
bool	poolComplete [get, set]
	Is the object done disposing.
DisposeContext	disposingContext [get]
	The DepictionEngine.DisposeContext under which the object was destroyed.
Properties inherited from DepictionEngine.IProperty
SerializableGuid	id [get]
	The DepictionEngine.SerializableGuid of the object.
Action< IProperty, string, object, object >	PropertyAssignedEvent [get, set]
	Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.
Properties inherited from DepictionEngine.IPersistent
bool	autoDispose [get]
bool	dontSaveToScene [get, set]
bool	containsCopyrightedMaterial [get]
bool	createPersistentIfMissing [get]
Action< IPersistent, Action >	PersistenceSaveOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.
Action< IPersistent, Action >	PersistenceSynchronizeOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.
Action< IPersistent, Action >	PersistenceDeleteOperationEvent [get, set]
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.

Additional Inherited Members
Public Types inherited from DepictionEngine.AstroObject
enum	PlanetType {   Select , Sun , Moon , Mercury ,   Venus , Earth , Mars , Jupiter ,   Saturn , Uranus , Neptune , Pluto }
	Solar system planets, satellite and star.
Static Public Member Functions inherited from DepictionEngine.GeoAstroObject
static double	GetAstroObjectSize (PlanetType astroObject)
static GeoAstroObject	GetClosestGeoAstroObject (Vector3Double point)
Static Public Member Functions inherited from DepictionEngine.AstroObject
static double	GetPlanetMass (PlanetType planet)
Static Public Member Functions inherited from DepictionEngine.PropertyMonoBehaviour
static int	GetPropertyKey (string name)
	Returns a key for the property name.
Static Public Member Functions inherited from DepictionEngine.MonoBehaviourDisposable
static bool	InitValueInternal< T > (Action< T > callback, T defaultValue, Func< T > duplicateValue, InitializationContext initializingContext)
static bool	InitValueInternal< T > (Action< T > callback, T defaultValue, InitializationContext initializingContext)
static bool	operator!= (MonoBehaviourDisposable lhs, Disposable.Null rhs)
static bool	operator== (MonoBehaviourDisposable lhs, Disposable.Null _)
Public Attributes inherited from DepictionEngine.GeoAstroObject
Action< Grid2DIndexTerrainGridMeshObjects, Vector2Int, Vector2Int >	TerrainGridMeshObjectAddedEvent
	Dispatched when a DepictionEngine.Grid2DIndexTerrainGridMeshObjects is added at a specific zoom level and index in the DepictionEngine.GeoAstroObject grid.
Action< Grid2DIndexTerrainGridMeshObjects, Vector2Int, Vector2Int >	TerrainGridMeshObjectRemovedEvent
	Dispatched when a DepictionEngine.Grid2DIndexTerrainGridMeshObjects is Removed from a specific zoom level and index in the DepictionEngine.GeoAstroObject grid.
Action< Grid2DIndexTerrainGridMeshObjects >	TerrainGridMeshObjectMeshModifiedEvent
	Dispatched when the DepictionEngine.MeshRendererVisual's of any of the DepictionEngine.TerrainGridMeshObject are modified.
Action< Grid2DIndexTerrainGridMeshObjects >	TerrainGridMeshObjectElevationChangedEvent
	Dispatched when the DepictionEngine.MeshRendererVisual's of any of the DepictionEngine.TerrainGridMeshObject are modified.
Action< Grid2DIndexTerrainGridMeshObjects >	TerrainGridMeshObjectAltitudeOffsetChangedEvent
	Dispatched when the DepictionEngine.MeshRendererVisual's of any of the DepictionEngine.TerrainGridMeshObject are modified.
Public Attributes inherited from DepictionEngine.Object
Action< Object, PropertyMonoBehaviour >	ChildAddedEvent
	Dispatched when a child such as DepictionEngine.TransformDouble or DepictionEngine.MeshRendererVisual(for DepictionEngine.VisualObject) is added.
Action< Object, PropertyMonoBehaviour >	ChildRemovedEvent
	Dispatched when a child such as DepictionEngine.TransformDouble or DepictionEngine.MeshRendererVisual(for DepictionEngine.VisualObject) is removed.
Action< Object, string, object, object >	ChildObjectPropertyAssignedEvent
	Dispatched when a property assign event is detected in the DepictionEngine.Object of one of the child DepictionEngine.TransformDouble.
Action< Object, Script >	ScriptAddedEvent
	Dispatched when a DepictionEngine.Script is added.
Action< Object, Script >	ScriptRemovedEvent
	Dispatched when a DepictionEngine.Script is removed.
Action< Object, IJson, string, object, object >	ComponentPropertyAssignedEvent
	Dispatched when a property assign event is detected in any of the DepictionEngine.Script or DepictionEngine.TransformDouble.
Action< TransformBase.Component, TransformBase.Component >	TransformChangedEvent
	Dispatched after changes to the DepictionEngine.TransformDouble.localPosition, DepictionEngine.TransformDouble.localRotation or DepictionEngine.TransformDouble.localScale have been detected.
Action< TransformBase, string, object, object >	TransformPropertyAssignedEvent
	Dispatched when a property assign event is detected in the DepictionEngine.TransformDouble.
Action< GeoAstroObject, string, object, object >	ParentGeoAstroObjectPropertyAssignedEvent
	Dispatched when a property assign event is detected in the parent DepictionEngine.GeoAstroObject.
Action< LocalPositionParam, LocalRotationParam, LocalScaleParam, Camera >	TransformControllerCallback
	A callback triggered by changes in the DepictionEngine.TransformDouble allowing you to make changes to the new values before they are assigned.
	string
Static Public Attributes inherited from DepictionEngine.GeoAstroObject
const double	DEFAULT_SIZE = 40000000.0d
Static Public Attributes inherited from DepictionEngine.AstroObject
const double	DEFAULT_MASS = 1000000000000000000.0f
Static Public Attributes inherited from DepictionEngine.PersistentMonoBehaviour
const string	AUTO_SYNCHRONIZE_INTERVAL_TOOLTIP = "The interval (in seconds) at which we call the '"+nameof(Synchronize)+ "' function. Automatically calling '"+nameof(Synchronize)+"' can be useful to keep objects in synch with a datasource. Set to zero to deactivate."
const string	AUTO_DISPOSE_TOOLTIP = "When enabled, the object can be disposed automatically by its datasource if it is no longer required in any loader and does not have any out of synch properties."
const string	DONT_SAVE_TO_SCENE_TOOLTIP = "When enabled, the object will not be saved as part of the Scene."
Protected Attributes inherited from DepictionEngine.PropertyMonoBehaviour
bool	ignoreGameObjectActiveChange

Detailed Description

A light source, and lens flare effect, emitting light in all directions.

Member Function Documentation

CreateAndInitializeDependencies()

override void DepictionEngine.Star.CreateAndInitializeDependencies ( InitializationContext  initializingContext )

protectedvirtual

Reimplemented from DepictionEngine.Object.

HierarchicalEndCameraRendering()

override bool DepictionEngine.Star.HierarchicalEndCameraRendering ( Camera  camera )

virtual

Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the RenderPipelineManager.endCameraRendering.

Reimplemented from DepictionEngine.PropertyMonoBehaviour.

InitializeSerializedFields()

override void DepictionEngine.Star.InitializeSerializedFields ( InitializationContext  initializingContext )

protectedvirtual

Initialize SerializedField's to their default values.

Parameters

initializingContext

Reimplemented from DepictionEngine.GeoAstroObject.

PreHierarchicalUpdate()

override bool DepictionEngine.Star.PreHierarchicalUpdate ( )

virtual

Called as a result of a hierarchical traversal of the scenegraph initiated at the same time as the UnityEngine Update. It is called before the DepictionEngine.PropertyMonoBehaviour.HierarchicalUpdate.

Reimplemented from DepictionEngine.Object.

RequiresPositioning()

override bool DepictionEngine.Star.RequiresPositioning ( )

virtual

Used to tell whether or not this object should be positioned in space according to its transform or kept to identity transform(origin) during origin shifting.

Returns

If true the object will be positioned in space otherwise it will remain static at identity transform(origin).

Reimplemented from DepictionEngine.Object.

---

The documentation for this class was generated from the following file:

• Star.cs