Scene Class |
Represents a scene.
Inheritance HierarchyNamespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)
SyntaxC#
public class Scene : Component
The Scene type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
  | _InternalRendering | |
| _InternalSimulatePhysics | |
| AnyData |
The user data of the component.
(Inherited from Component) |
| BackgroundColor | The background color of the scene. |
| BackgroundColorAffectLighting | Whether to affect the background color to ambient lighting. |
| BackgroundColorEnvironmentOverride | |
| BackgroundSound | Specifies background sound of the scene. Usually it is a music. |
| BackgroundSoundChannel | |
| BackgroundSoundVolumeInEditor | Specifies background sound volume in the editor. |
| BackgroundSoundVolumeInSimulation | Specifies background sound volume in the simulation. |
| BaseType |
Gets the base type of the object.
(Inherited from Component) |
| BoundsWhenSimulationStarted | |
| CachedDirectionalLightsToFastFindByRenderingPipeline | |
| CachedObjectsInSpaceToFastFindByRenderingPipeline | |
| CameraDefault | The default camera used. |
| CameraEditor | The camera used by the editor in 3D mode. |
| CameraEditor2D | The camera used by the editor in 2D mode. |
| CameraEditor2DPositionZ | Z position of the camera in 2D mode. |
| CloneSupport |
Whether the object supports cloning.
(Inherited from Component) |
| Components |
Gets the collection of the child components.
(Inherited from Component) |
| CreatedByBaseType |
Whether the object is created using a base type.
(Inherited from Component) |
| DisplayAreas | Whether to display areas. |
| DisplayCameras | Whether to display development data of the cameras. |
| DisplayDecals | Whether to display development data of the decals. |
| DisplayDevelopmentDataInEditor | Whether to show development data in the editor. |
| DisplayDevelopmentDataInSimulation | Whether to show development data in the simulation. |
| DisplayInEditor |
Whether to show the object in the editor.
(Inherited from Component) |
| DisplayLabels | Whether to display development data of the labels. |
| DisplayLights | Whether to display development data of the lights. |
| DisplayObjectInSpaceBounds | Whether to display the bounds of the objects in space. |
| DisplayPhysicalObjects | Whether to display physical objects. |
| DisplayReflectionProbes | Whether to display development data of the reflection probes. |
| DisplaySceneOctree | Whether to display the scene octree. |
| DisplaySensors | Whether to display sensors. |
| DisplaySoundSources | Whether to display development data of the sound sources. |
| DisplayTextInfo | Whether to display text information of the development data. |
| DisplayVolumes | Whether to display volumes. |
| Disposed |
Whether the object is disposed.
(Inherited from Component) |
| EditorDocumentConfiguration |
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component) |
| EditorReadOnly |
Whether the object is read only in the editor.
(Inherited from Component) |
| EditorReadOnlyInHierarchy |
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component) |
| Enabled |
Whether the component is enabled. Any functionality of component is not works when it disabled.
(Inherited from Component) |
| EnabledInHierarchy |
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) |
| EnabledInHierarchyAndIsInstance |
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) |
| First | Gets first enabled scene. |
| FrustumCullingTest | Enables the frustum culling test. |
| Gravity | The gravity applied on the physical objects. |
| Gravity2D | The gravity applied on the 2D physical objects. |
| HierarchyController |
Gets the object hierarchy control controller.
(Inherited from Component) |
| IsResource | (Inherited from Component) |
| MeshInSpaceStaticModeSectorSize | |
| Mode | The mode of the scene. |
| Name |
The name of the component.
(Inherited from Component) |
| NetworkID | (Inherited from Component) |
| NetworkIsClient | (Inherited from Component) |
| NetworkIsServer |
Whether to work in network server mode. It is false until the scene is not loaded.
(Inherited from Component) |
| NetworkIsSingle | (Inherited from Component) |
| NetworkIsSingleOrClient | (Inherited from Component) |
| NetworkMode |
Whether to enable synchronization of the component between server and clients.
(Inherited from Component) |
| NetworkModeUsers | (Inherited from Component) |
| OctreeBoundsRebuildExpand | The expand vector of the octree bounds. |
| OctreeEnabled | Enables the scene octree. |
| OctreeMaxNodeCount | The maximum number of nodes created by the octree. |
| OctreeMinNodeSize | The minimum node size of the octree. |
| OctreeObjectCountOutsideOctreeToRebuld | The number of objects to rebuild outside the octree. |
| OctreeObjectCountToCreateChildNodes | The number of objects needed to create child nodes. |
| OctreeThreadingMode | |
| Parent |
Gets the parent object.
(Inherited from Component) |
| ParentRoot |
Gets the parent root object.
(Inherited from Component) |
| PhysicsAdvancedSettings | Whether to enabled advanced settings of the physics world. |
| PhysicsAllowSleeping | If objects can go to sleep or not. |
| PhysicsBaumgarte | Baumgarte stabilization factor (how much of the position error to 'fix' in 1 update) (unit: dimensionless, 0 = nothing, 1 = 100%). |
| PhysicsBodyPairCacheCosMaxDeltaRotationDiv2 | Maximum relative delta orientation for body pairs to be able to reuse collision results from last frame, stored as cos(max angle / 2). Default: cos(2 degrees / 2). |
| PhysicsBodyPairCacheMaxDeltaPosition | Maximum relative delta position for body pairs to be able to reuse collision results from last frame (units: meter). |
| PhysicsCheckActiveEdges | When false, we prevent collision against non-active (shared) edges. Mainly for debugging the algorithm. |
| PhysicsCollisionSteps | The amount of collision steps for one update. |
| PhysicsConstraintWarmStart | Whether or not to use warm starting for constraints (initially applying previous frames impulses). |
| PhysicsContactNormalCosMaxDeltaRotation | Maximum angle between normals that allows manifolds between different sub shapes of the same body pair to be combined. Default: cos(5 degree). |
| PhysicsContactPointPreserveLambdaMaxDist | Maximum allowed distance between old and new contact point to preserve contact forces for warm start (units: meter). |
| PhysicsDefaultConvexRadius | In order to speed up the collision detection system, all convex shapes use a convex radius. The provided shape will first be shrunken by the convex radius and then inflated again by the same amount. |
| PhysicsDeterministicSimulation | Whether to enable the deterministic simulation. This will make the simulation run faster but it will no longer be deterministic. |
| PhysicsLinearCastMaxPenetration | Fraction of its inner radius a body may penetrate another body for the LinearCast motion quality. |
| PhysicsLinearCastThreshold | Fraction of its inner radius a body must move per step to enable casting for the LinearCast motion quality. |
| PhysicsManifoldTolerance | Max squared distance to use to determine if two points are on the same plane for determining the contact manifold between two shape faces (unit: meter). |
| PhysicsMaxBodies | The max amount of bodies at the same time in the scene. Reopen the scene to apply changes. |
| PhysicsMaxBodyPairs | Maximum amount of body pairs to process (anything else will fall through the world), this number should generally be much higher than the max amount of contact points as there will be lots of bodies close that are not actually touching. Set for to auto mode. |
| PhysicsMaxContactConstraints | Maximum amount of contact constraints to process (anything else will fall through the world). Set 0 for auto mode. |
| PhysicsMaxInFlightBodyPairs | Size of body pairs array, corresponds to the maximum amount of potential body pairs that can be in flight at any time. Setting this to a low value will use less memory but slow down simulation as threads may run out of narrow phase work. Set 0 for auto mode. |
| PhysicsMaxPenetrationDistance | Maximum distance to correct in a single iteration when solving position constraints (unit: meters). |
| PhysicsMinVelocityForRestitution | Minimal velocity needed before a collision can be elastic (unit: m). |
| PhysicsNumPositionSteps | Number of solver position iterations to run. |
| PhysicsNumVelocitySteps | Number of solver velocity iterations to run. Note that this needs to be >= 2 in order for friction to work (friction is applied using the non-penetration impulse from the previous iteration). |
| PhysicsPenetrationSlop | How much bodies are allowed to sink into eachother (unit: meters). |
| PhysicsPointVelocitySleepThreshold | Velocity of points on bounding box of object below which an object can be considered sleeping (unit: m/s). |
| PhysicsSpeculativeContactDistance | Radius around objects inside which speculative contact points will be detected (unit: meters). |
| PhysicsStepListenerBatchesPerJob | How many step listener batches are needed before spawning another job. Set to 2147483647 (INT_MAX) if no parallelism is desired. |
| PhysicsStepListenersBatchSize | How many PhysicsStepListeners to notify in 1 batch. |
| PhysicsTimeBeforeSleep | Time before object is allowed to go to sleep (unit: seconds). |
| PhysicsUseBodyPairContactCache | Whether or not to use the body pair cache, which removes the need for narrow phase collision detection when orientation between two bodies didn't change. |
| PhysicsUseLargeIslandSplitter | Whether to split up large islands into smaller parallel batches of work to improve performance. |
| PhysicsUseManifoldReduction | Whether or not to reduce manifolds with similar contact normals into one contact manifold. |
| PhysicsWorld | |
| PrecipitationFallen | |
| PrecipitationFalling | |
| RemoveFromParentQueued |
Whether the object is placed in the detach queue from the parent.
(Inherited from Component) |
| RenderingPipeline | The rendering pipeline of the scene. |
| SaveSupport |
Whether the object supports saving to a file.
(Inherited from Component) |
| ScreenLabel |
The displaying mode of an on-screen label of the component in the scene editor.
(Inherited from Component) |
| ScreenOrientation | The way to override default screen orientation settings for the scene. The property is used for mobile devices. |
| SoundAttenuationFar | The default maximum distance from the listener, after which no sound is heard. |
| SoundAttenuationNear | The default minimum distance from the listener, after which the sound begins to weaken. |
| SoundRolloffFactor | The default damping factor. |
| Temperature | |
| Time | |
| TimeOfDay | |
| TypeSettingsPrivateObjects |
Object settings when used as a type.
(Inherited from Component) |
| UIScreen | The element of the user interface of the scene that will be used in a simulation. |
| WindDirection | The direction of the wind. |
| WindSpeed | The speed of the wind. |
Methods| Name | Description | |
|---|---|---|
 | AddComponent |
Adds a component as a child.
(Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) | (Inherited from Component) |
| BeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) | (Inherited from Component) |
| BeginNetworkMessageToEveryone | (Inherited from Component) |
| BeginNetworkMessageToServer | (Inherited from Component) |
| CalculateTotalBoundsOfObjectsInSpace | |
| Clone |
Creates a copy of the object.
(Inherited from Component) |
| CreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| CreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
(Inherited from Component) |
| Dispose |
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindParent(Type) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParent(MetadataTypeInfo) |
Finds the parent of the specified type.
(Inherited from Component) |
| FindParentT |
Finds the parent of the specified type.
(Inherited from Component) |
| FindThisOrParent(Type) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParent(MetadataTypeInfo) |
Finds the parent or self of the specified type.
(Inherited from Component) |
| FindThisOrParentT |
Finds the parent or self of the specified type.
(Inherited from Component) |
| GetAll | Gets the list of all scene objects including resources. |
| GetAllInstancesEnabled | Gets the list of all enabled instances of scenes. |
| GetAllParents |
Gets all parents of the component.
(Inherited from Component) |
| GetComponent(String, Boolean) |
Finds a child component by name.
(Inherited from Component) |
| GetComponent(Type, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponent(MetadataTypeInfo, Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentT(Boolean, Boolean) |
Finds a child component of the specified type.
(Inherited from Component) |
| GetComponentByNameWithIndex |
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component) |
| GetComponentByPath |
Finds a child component by path.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean) |
Finds child components.
(Inherited from Component) |
| GetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) |
Finds child components.
(Inherited from Component) |
| GetComponents(Type, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
(Inherited from Component) |
| GetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) |
Finds child components of the specified type.
(Inherited from Component) |
| GetDisplayDevelopmentDataInThisApplication | |
| GetGameMode | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetObjectsInSpace(SceneGetObjectsInSpaceItem, Int32) | |
| GetObjectsInSpace(IListSceneGetObjectsInSpaceItem, Int32) | |
| GetOctreeStatistics | |
| GetPathFromParent |
Returns the path to the object from the parent.
(Inherited from Component) |
| GetPathFromRoot |
Returns the object's access path from the root object.
(Inherited from Component) |
| GetProvidedType |
Returns a type when the object is used as a type.
(Inherited from Component) |
| GetScreenLabelInfo | (Inherited from Component) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetWindSpeedVector | |
| IsMethodInvoking |
Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MetadataGetMemberBySignature |
Returns the object metadata member by name.
(Inherited from Component) |
| MetadataGetMembers |
Returns the object metadata members.
(Inherited from Component) |
| MethodInvoke |
Calls a method by name.
(Inherited from Component) |
| MethodInvokeCancel |
Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| MethodInvokeCancelAll |
Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component) |
| NetworkDisablePropertySynchronization | (Inherited from Component) |
| NetworkIsDisabledPropertySynchronization | (Inherited from Component) |
| NetworkModeAddUser | (Inherited from Component) |
| NetworkModeIsEnabledForUser | (Inherited from Component) |
| NetworkModeRemoveUser | (Inherited from Component) |
| NetworkRestoreDisabledPropertySynchronization | (Inherited from Component) |
| NewObjectSetDefaultConfiguration |
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component) |
| NewObjectSetDefaultConfigurationUpdate |
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component) |
| ObjectsInSpace_ObjectUpdateSceneObjectFlags | |
| OctreeUpdate | |
| OnAddedToParent |
Called when a component is added to the parent.
(Inherited from Component) |
| OnClientConnectedAfterRootComponentEnabled | (Inherited from Component) |
| OnClientConnectedBeforeRootComponentEnabled | (Inherited from Component) |
| OnClientDisconnected | (Inherited from Component) |
| OnClone |
Called when the object is cloned.
(Inherited from Component) |
| OnComponentAdded | (Overrides ComponentOnComponentAdded(Component)) |
| OnComponentRemoved | (Overrides ComponentOnComponentRemoved(Component)) |
| OnDisabled |
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnDisabledInSimulation |
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) |
| OnDispose |
Called when the object is disposed.
(Inherited from Component) |
| OnEditorGetTextInfoCenterBottomCorner | (Inherited from Component) |
| OnEnabled |
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component) |
| OnEnabledChanged |
Called when value of Enabled property is changed.
(Inherited from Component) |
| OnEnabledInHierarchyChanged |
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component) |
| OnEnabledInSimulation |
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) |
| OnGetRenderSceneData | |
| OnLoad |
Called during object loading.
(Inherited from Component) |
| OnMetadataGetMemberBySignature |
Called when the object metadata member is received by name.
(Inherited from Component) |
| OnMetadataGetMembers |
Called upon receipt of the object's metadata members.
(Inherited from Component) |
| OnMetadataGetMembersFilter | (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean)) |
| OnPreloadResources |
Called when preloading the resources used by the object.
(Inherited from Component) |
| OnReceiveNetworkMessageFromClient | (Inherited from Component) |
| OnReceiveNetworkMessageFromServer | (Inherited from Component) |
| OnRemovedFromParent |
Called when a component is removed from the parent.
(Inherited from Component) |
| OnRender | |
| OnRenderBeforeOutput | |
| OnSave |
Called during object saving.
(Inherited from Component) |
| OnSimulationStep |
Called during the simulation step.
(Inherited from Component) |
| OnSimulationStepClient |
Called during the simulation step.
(Inherited from Component) |
| OnUpdate | (Overrides ComponentOnUpdate(Single)) |
| OnViewportUpdateBefore | |
| OnViewportUpdateBegin | |
| OnViewportUpdateCameraSettingsReady | |
| OnViewportUpdateEnd | |
| Physics2DContactTest(Physics2DContactTestItem) | |
| Physics2DContactTest(Physics2DContactTestItem) | |
| Physics2DGetWorld | |
| Physics2DRayTest(Physics2DRayTestItem) | |
| Physics2DRayTest(Physics2DRayTestItem) | |
| PhysicsRayTest(PhysicsRayTestItem) | |
| PhysicsRayTest(PhysicsRayTestItem, Boolean) | |
| PhysicsVolumeTest(PhysicsVolumeTestItem) | |
| PhysicsVolumeTest(PhysicsVolumeTestItem, Boolean) | |
| PreloadResources |
Preload resources used by the object.
(Inherited from Component) |
| PropertyGet(String, Object, Boolean) |
Gets the value of a property by name.
(Inherited from Component) |
| PropertySet |
Sets the value of a property by name.
(Inherited from Component) |
| RemoveAllComponents |
Removes all child components.
(Inherited from Component) |
| RemoveComponent |
Removes a child component.
(Inherited from Component) |
| RemoveFromParent |
Detaches the object from its parent.
(Inherited from Component) |
| SoundPlay(SoundData, Vector3, Double, Double) | |
| SoundPlay(Sound, Vector3, Double, Double, Boolean) | |
| SoundPlay(String, Vector3, Double, Double, Boolean) | |
| SoundPlay2D(Sound) | |
| SoundPlay2D(String) | |
| SoundPlay2D(SoundData, Double, Double) | |
| ToString |
Returns the name and type of the object as a string.
(Inherited from Component) |
| TypeSettingsIsPublic |
Checks whether the object provided as a type is public.
(Inherited from Component) |
| TypeSettingsIsPublicMember |
Checks whether the member is set up as public.
(Inherited from Component) |
EventsTop
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx) |
| PropertyGet |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertyGetT |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx) |
See Also