Click or drag to resize

Scene Class

Represents a scene.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2022.1.1.0 (2022.1.1.0)
Syntax
C#
public class Scene : Component

The Scene type exposes the following members.

Constructors
  NameDescription
Public methodScene
Initializes a new instance of the Scene class
Top
Properties
  NameDescription
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBackgroundColor
The background color of the scene.
Public propertyBackgroundColorAffectLighting
Whether to affect the background color to ambient lighting.
Public propertyBackgroundColorEnvironmentOverride
Public propertyBackgroundSound
Specifies background sound of the scene. Usually it is a music.
Public propertyBackgroundSoundVolumeInEditor
Specifies background sound volume in the editor.
Public propertyBackgroundSoundVolumeInSimulation
Specifies background sound volume in the simulation.
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyBoundsWhenSimulationStarted
Public propertyCachedObjectsInSpaceToFastFindByRenderingPipeline
Public propertyCameraDefault
The default camera used.
Public propertyCameraEditor
The camera used by the editor in 3D mode.
Public propertyCameraEditor2D
The camera used by the editor in 2D mode.
Public propertyCameraEditor2DPositionZ
Z position of the camera in 2D mode.
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyDisplayAreas
Whether to display areas.
Public propertyDisplayCameras
Whether to display development data of the cameras.
Public propertyDisplayDecals
Whether to display development data of the decals.
Public propertyDisplayDevelopmentDataInEditor
Whether to show development data in the editor.
Public propertyDisplayDevelopmentDataInSimulation
Whether to show development data in the simulation.
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
Public propertyDisplayLabels
Whether to display development data of the labels.
Public propertyDisplayLights
Whether to display development data of the lights.
Public propertyDisplayObjectInSpaceBounds
Whether to display the bounds of the objects in space.
Public propertyDisplayPhysicalObjects
Whether to display physical objects.
Public propertyDisplayPhysicsInternal
Whether to display the internal physics data.
Public propertyDisplayReflectionProbes
Whether to display development data of the reflection probes.
Public propertyDisplaySceneOctree
Whether to display the scene octree.
Public propertyDisplaySensors
Whether to display sensors.
Public propertyDisplaySoundSources
Whether to display development data of the sound sources.
Public propertyDisplayTextInfo
Whether to display text information of the development data.
Public propertyDisplayVolumes
Whether to display volumes.
Public propertyDisposed
Whether the object is disposed.
(Inherited from Component.)
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component.)
Public propertyEditorReadOnly
Whether the object is read only in the editor.
(Inherited from Component.)
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component.)
Public propertyEnabled
Whether the component is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public propertyEnabledInHierarchy
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyEnabledInHierarchyAndIsNotResource
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component.)
Public propertyStatic memberFirst
Gets first enabled scene.
Public propertyFrustumCullingTest
Enables the frustum culling test.
Public propertyGravity
The gravity applied on the physical objects.
Public propertyGravity2D
The gravity applied on the 2D physical objects.
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyHumidity
Public propertyMode
The mode of the scene.
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyOctreeBoundsRebuildExpand
The expand vector of the octree bounds.
Public propertyOctreeEnabled
Enables the scene octree.
Public propertyOctreeMaxNodeCount
The maximum number of nodes created by the octree.
Public propertyOctreeMinNodeSize
The minimum node size of the octree.
Public propertyOctreeObjectCountOutsideOctreeToRebuld
The number of objects to rebuild outside the octree.
Public propertyOctreeObjectCountToCreateChildNodes
The number of objects needed to create child nodes.
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyPhysicsNumberIterations
The number of iterations performed by the physics system.
Public propertyPhysicsSimulationSteps
The number of simulation sub-steps performed by the physics system per one update.
Public propertyPhysicsWorldData
Public propertyPrecipitation
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertyRenderingPipeline
The rendering pipeline of the scene.
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
Public propertySeason
Season of a year. 0 - summer, 1 - fall, 2 - winter, 3 - spring.
Public propertyTemperature
Public propertyTime
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyUIScreen
The element of the user interface of the scene that will be used in a simulation.
Public propertyWindDirection
The direction of the wind.
Public propertyWindSpeed
The speed of the wind.
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
Public methodCalculateTotalBoundsOfObjectsInSpace
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindParent(Type)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParentT
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodStatic memberGetAll
Gets the list of all scene objects including resources.
Public methodStatic memberGetAllInstancesEnabled
Gets the list of all enabled instances of scenes.
Public methodGetAllParents
Gets all parents of the component.
(Inherited from Component.)
Public methodGetComponent(String, Boolean)
Finds a child component by name.
(Inherited from Component.)
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component.)
Public methodGetComponentByPath
Finds a child component by path.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetDisplayDevelopmentDataInThisApplication
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectsInSpace(SceneGetObjectsInSpaceItem)
Public methodGetObjectsInSpace(IListSceneGetObjectsInSpaceItem)
Public methodGetPathFromParent
Returns the path to the object from the parent.
(Inherited from Component.)
Public methodGetPathFromRoot
Returns the object's access path from the root object.
(Inherited from Component.)
Public methodGetProvidedType
Returns a type when the object is used as a type.
(Inherited from Component.)
Public methodGetScreenLabelInfo (Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWindSpeedVector
Public methodIsMethodInvoking (Inherited from Component.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
(Inherited from Component.)
Public methodMetadataGetMembers
Returns the object metadata members.
(Inherited from Component.)
Public methodMethodInvoke
Calls a method by name.
(Inherited from Component.)
Public methodMethodInvokeCancel (Inherited from Component.)
Public methodMethodInvokeCancelAll (Inherited from Component.)
Public methodNewObjectSetDefaultConfiguration
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodOctreeUpdate
Protected methodOnAddedToParent
Called when a component is added to the parent.
(Inherited from Component.)
Protected methodOnClone
Called when the object is cloned.
(Inherited from Component.)
Protected methodOnComponentAdded
Called when a child component is added.
(Inherited from Component.)
Protected methodOnComponentRemoved
Called when a child component is removed.
(Inherited from Component.)
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDisabledInSimulation
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnDispose
Called when the object is disposed.
(Inherited from Component.)
Protected methodOnEditorGetTextInfoCenterBottomCorner (Inherited from Component.)
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
(Inherited from Component.)
Protected methodOnEnabledInHierarchyChanged
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component.)
Protected methodOnEnabledInSimulation
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnGetRenderSceneData
Protected methodOnLoad
Called during object loading.
(Inherited from Component.)
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
(Inherited from Component.)
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
(Inherited from Component.)
Protected methodOnMetadataGetMembersFilter (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean).)
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
(Inherited from Component.)
Protected methodOnRemovedFromParent
Called when a component is removed from the parent.
(Inherited from Component.)
Protected methodOnRender
Public methodOnRenderBeforeOutput
Protected methodOnSave
Called during object saving.
(Inherited from Component.)
Protected methodOnSimulationStep
Called during the simulation step.
(Inherited from Component.)
Protected methodOnUpdate (Overrides ComponentOnUpdate(Single).)
Protected methodOnViewportUpdateBefore
Protected methodOnViewportUpdateBegin
Protected methodOnViewportUpdateEnd
Public methodPhysics2DContactTest(Physics2DContactTestItem)
Public methodPhysics2DContactTest(Physics2DContactTestItem)
Public methodPhysics2DGetWorld
Public methodPhysics2DRayTest(Physics2DRayTestItem)
Public methodPhysics2DRayTest(Physics2DRayTestItem)
Public methodPhysicsContactTest(PhysicsContactTestItem)
Public methodPhysicsContactTest(PhysicsContactTestItem)
Public methodPhysicsConvexSweepTest(PhysicsConvexSweepTestItem)
Public methodPhysicsConvexSweepTest(PhysicsConvexSweepTestItem)
Public methodPhysicsRayTest(PhysicsRayTestItem)
Public methodPhysicsRayTest(PhysicsRayTestItem)
Public methodPreloadResources
Preload resources used by the object.
(Inherited from Component.)
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
(Inherited from Component.)
Public methodPropertySet
Sets the value of a property by name.
(Inherited from Component.)
Public methodRemoveAllComponents
Removes all child components.
(Inherited from Component.)
Public methodRemoveComponent
Removes a child component.
(Inherited from Component.)
Public methodRemoveFromParent
Detaches the object from its parent.
(Inherited from Component.)
Public methodSoundPlay(String, Vector3)
Public methodSoundPlay(Sound, Vector3)
Public methodSoundPlay(SoundData, Vector3)
Public methodSoundPlay2D(Sound)
Public methodSoundPlay2D(SoundData)
Public methodToString
Returns the name and type of the object as a string.
(Inherited from Component.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
(Inherited from Component.)
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventStatic memberAllScenes_GetRenderSceneData
Public eventBackgroundColorAffectLightingChanged
Occurs when the BackgroundColorAffectLighting property value changes.
Public eventBackgroundColorChanged
Occurs when the BackgroundColor property value changes.
Public eventBackgroundSoundChanged
Occurs when the BackgroundSound property value changes.
Public eventBackgroundSoundVolumeInEditorChanged
Occurs when the BackgroundSoundVolumeInEditor property value changes.
Public eventBackgroundSoundVolumeInSimulationChanged
Occurs when the BackgroundSoundVolumeInSimulation property value changes.
Public eventCameraDefaultChanged
Occurs when the CameraDefault property value changes.
Public eventCameraEditor2DChanged
Occurs when the CameraEditor2D property value changes.
Public eventCameraEditorChanged
Occurs when the CameraEditor property value changes.
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventComponentAdded
Occurs when a child component is added.
(Inherited from Component.)
Public eventComponentRemoved
Occurs when a child component is removed.
(Inherited from Component.)
Public eventComponentsChanged
Occurs when the set of children is changed.
(Inherited from Component.)
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisabledInSimulation
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventDisplayAreasChanged
Occurs when the DisplayAreas property value changes.
Public eventDisplayCamerasChanged
Occurs when the DisplayCameras property value changes.
Public eventDisplayDecalsChanged
Occurs when the DisplayDecals property value changes.
Public eventDisplayDevelopmentDataInEditorChanged
Occurs when the DisplayDevelopmentDataInEditor property value changes.
Public eventDisplayDevelopmentDataInSimulationChanged
Occurs when the DisplayDevelopmentDataInSimulation property value changes.
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
Public eventDisplayLabelsChanged
Occurs when the DisplayLabels property value changes.
Public eventDisplayLightsChanged
Occurs when the DisplayLights property value changes.
Public eventDisplayObjectInSpaceBoundsChanged
Occurs when the DisplayObjectInSpaceBounds property value changes.
Public eventDisplayPhysicalObjectsChanged
Occurs when the DisplayPhysicalObjects property value changes.
Public eventDisplayPhysicsInternalChanged
Occurs when the DisplayPhysicsInternal property value changes.
Public eventDisplayReflectionProbesChanged
Occurs when the DisplayReflectionProbes property value changes.
Public eventDisplaySceneOctreeChanged
Occurs when the DisplaySceneOctree property value changes.
Public eventDisplaySensorsChanged
Occurs when the DisplaySensors property value changes.
Public eventDisplaySoundSourcesChanged
Occurs when the DisplaySoundSources property value changes.
Public eventDisplayTextInfoChanged
Occurs when the DisplayTextInfo property value changes.
Public eventDisplayVolumesChanged
Occurs when the DisplayVolumes property value changes.
Public eventDisposeEvent
Occurs when the object is disposed.
(Inherited from Component.)
Public eventEnabledChanged
Occurs when the Enabled property value changes.
(Inherited from Component.)
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component.)
Public eventEnabledInSimulation
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventFrustumCullingTestChanged
Occurs when the FrustumCullingTest property value changes.
Public eventGetDisplayDevelopmentDataInThisApplicationOverride
Public eventGetObjectsInSpaceOverride
Public eventGetRenderSceneData
Public eventGravity2DChanged
Occurs when the Gravity2D property value changes.
Public eventGravityChanged
Occurs when the Gravity property value changes.
Public eventHumidityChanged
Occurs when the Humidity property value changes.
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
(Inherited from Component.)
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
(Inherited from Component.)
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
(Inherited from Component.)
Public eventModeChanged
Public eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventOctreeBoundsRebuildExpandChanged
Occurs when the OctreeBoundsRebuildExpand property value changes.
Public eventOctreeEnabledChanged
Occurs when the OctreeEnabled property value changes.
Public eventOctreeMaxNodeCountChanged
Occurs when the OctreeMaxNodeCount property value changes.
Public eventOctreeMinNodeSizeChanged
Occurs when the OctreeMinNodeSize property value changes.
Public eventOctreeObjectCountOutsideOctreeToRebuldChanged
Occurs when the OctreeObjectCountOutsideOctreeToRebuld property value changes.
Public eventOctreeObjectCountToCreateChildNodesChanged
Occurs when the OctreeObjectCountToCreateChildNodes property value changes.
Public eventPhysics2DSimulationStepAfter
Public eventPhysicsNumberIterationsChanged
Occurs when the PhysicsNumberIterations property value changes.
Public eventPhysicsSimulationStepAfter
Public eventPhysicsSimulationStepsChanged
Occurs when the PhysicsSimulationSteps property value changes.
Public eventPrecipitationChanged
Occurs when the Precipitation property value changes.
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventRenderEvent
Public eventRenderingPipelineChanged
Occurs when the RenderingPipeline property value changes.
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventSeasonChanged
Occurs when the Season property value changes.
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventTemperatureChanged
Occurs when the Temperature property value changes.
Public eventUIScreenChanged
Occurs when the UIScreen property value changes.
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventViewportUpdateBefore
Public eventViewportUpdateBegin
Public eventViewportUpdateEnd
Public eventViewportUpdateGetCameraSettings
Public eventWindDirectionChanged
Occurs when the WindDirection property value changes.
Public eventWindSpeedChanged
Occurs when the WindSpeed property value changes.
Top
Extension Methods
See Also