Class TCastleAbstractRootTransform

This item has no description.

Latest frame when VisibleChangeNotification was called (with any params, even empty).

Latest frame when VisibleChangeNotification was called (with vcVisibleGeometry).

Latest frame when VisibleChangeNotification was called (with vcVisibleNonGeometry).

Ignore (return True) transparent triangles (with Material.Transparency > 0).

This is suitable for TTriangleIgnoreFunc function, you can pass this to RayCollision and such.

This item has no description.

This item has no description.

This item has no description. Showing description inherited from TCastleTransform.Update.

Continuously occuring event, for various tasks.

Executed only on instances that have Exists (no need to check this in overridden Update implementation).

This item has no description. Showing description inherited from TCastleComponent.PropertySections.

Section where to show property in the editor.

This item has no description. Showing description inherited from TCastleComponent.CustomSerialization.

Override this method to call various methods of SerializationProcess, which in turn allows to serialize/deserialize things that are not published. This allows to serialize/deserialize with more freedom, e.g. to serialize/deserialize some private field.

Update everything when time passes, in particular updating physics. This makes physics recalculation and updates rigid bodies transformations. It also calls any other TCastleTransform.Update work.

Use this to simulate the passage of time without actually displaying the updated viewport. Useful e.g. to record the physics simulation results (to later play them back), see https://github.com/castle-engine/castle-dice-throwing .

Contrary to just Update, this always makes the processing, doesn't check did TFramesPerSecond.FrameId changed. This also doesn't check Exists, so can be called even on non-existing viewport.

The major axis of gravity vector: 0, 1 or 2. This is trivially derived from the known camera GravityUp value. It can only truly express GravityUp vector values (1,0,0) or (0,1,0) or (0,0,1), although in practice this is enough for normal games (normal 3D scenes use up either +Y or +Z).

We try to avoid using it in the engine, and use full GravityUp vector wherever possible. Full GravityUp vector may allow for more fun with weird gravity in future games.

This item has no description.

Is the move from OldPos to ProposedNewPos possible. Returns true and sets NewPos if some move is allowed, thus allows for wall-sliding.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

If your query originates from some existing TCastleTransform instance, you should prefer to instead use TCastleTransform.MoveAllowed method, that automatically prevents "collisions with yourself".

See also

TCastleTransform.MoveAllowed

Is the move from OldPos to NewPos possible for this object.

Is the move from OldPos to NewPos possible.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

If your query originates from some existing TCastleTransform instance, you should prefer to instead use TCastleTransform.MoveAllowed method, that automatically prevents "collisions with yourself".

See also

TCastleTransform.MoveAllowed

Is the move from OldPos to NewPos possible for this object.

Get height of point APosition above the world. Looks at current MainCamera to know the gravity direction.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

If your query originates from some existing TCastleTransform instance, you should prefer to instead use TCastleTransform.MoveAllowed method, that automatically prevents "collisions with yourself".

Check that the line segment between 2 points that not collide with anything (that has opaque material).

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

First object hit by the ray.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

First object hit by the ray.

Returns the TCastleTransform that is hit (this is the "leaf" TCastleTransform in the TCastleTransform tree that is hit) and a distance from RayOrigin to the hit point. Returns Nil (Distance is undefined in this case) if nothing was hit. Use WorldRay for a more advanced version of this, with more complicated result.

This item has no description.

Check whether something collides with axis-aligned box in 3D.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

Check whether something collides with a line segment.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

Check whether something collides with a sphere.

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

Check whether something collides with a sphere in 2D (a circle, extruded to infinity along the Z axis).

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

Check whether something collides with a point in 2D (which is an infinite line along the Z axis in 3D).

This checks collisions with world (everything inside this TCastleAbstractRootTransform).

This checks collision with all objects that have Collides and Exists equal True (using CheckCollides).

First object hit by the ray, calculated using the physics engine.

Returns the TRayCastResult record. Read TRayCastResult.Hit (boolean), TRayCastResult.Transform (guaranteed to be Nil when TRayCastResult.Hit is False) and other fields to know what was hit.

The given RayOrigin, RayDirection, Distance are in the world coordinate system.

It returns TRayCastResult, with information there also in the world coordinate system.

Collisions taken / not taken into account:

• Ignores the collider of IgnoreBody, if IgnoreBody is not Nil.

• Ignores collisions beyond MaxDistance, if MaxDistance <> MaxSingle. Passing some MaxDistance may also optimize the calculation.

• Only collisions with the physics colliders (TCastleCollider) are considered.

By default, the ray hits all physics layers, but you can choose physics layers in CollisionLayers attribute.

Note: The TCastleTransform.Pickable property is ignored by this method, i.e. it considers all colliders regardless of their TCastleTransform.Pickable value. The TCastleTransform.Pickable is only taken into account by the routines of the old physics system (see https://castle-engine.io/physics#_old_system_for_collisions_and_gravity ). In the new system, a similar role is filled by physics layers.

Check if moving a sphere in the given direction would collide with anything in the world.

Returns the TRayCastResult record. Read TRayCastResult.Hit (boolean), TRayCastResult.Transform (guaranteed to be Nil when TRayCastResult.Hit is False) and other fields to know what was hit.

The given SphereOrigin, SphereRadius, SphereDirection, MaxDistance are in the world coordinate system.

It returns TRayCastResult, with information there also in the world coordinate system.

Collisions taken / not taken into account:

• Ignores all colliders that overlap sphere at the initial position, before it is moved by SphereDirection.

• Ignores the collider of IgnoreBody, if IgnoreBody is not Nil.

• Ignores collisions that would occur is sphere is moved by move than MaxDistance, if MaxDistance <> MaxSingle. Passing some MaxDistance may also optimize the calculation.

• Only collisions with the physics colliders (TCastleCollider) are considered.

By default, the sphere cast hits all physics layers, but you can choose physics layers in CollisionLayers attribute.

Note: The TCastleTransform.Pickable property is ignored by this method, i.e. it considers all colliders regardless of their TCastleTransform.Pickable value. The TCastleTransform.Pickable is only taken into account by the routines of the old physics system (see https://castle-engine.io/physics#_old_system_for_collisions_and_gravity ). In the new system, a similar role is filled by physics layers.

Remove all items except TCastleCamera instances. This only avoids removing TCastleCamera instances that are direct children of this TCastleAbstractRootTransform, the TCastleCamera instances that are deeper (e.g. TCastleCamera inside some TCastleTransform) will still be removed.

Yoo can temporarily disable physics (no transformations will be updated by the physics engine) by setting this property to False.

Limit the movement allowed by WorldMoveAllowed. Ignored when empty (default).

This property allows to easily limit the possible places where player and creatures go. Player is honoring this if it uses WorldMoveAllowed, in particular our TCastleWalkNavigation navigation honors it. Creatures honor it if they use WorldMoveAllowed for their decision.

Central camera, that controls the features that require a single "main" camera (features that do not make sense with multiple cameras from multiple viewports).

This camera controls:

• Nodes that "sense" camera like TProximitySensorNode, TBillboardNode, TLODNode.

• TCastleBillboard.

• Audio listener (controlling the spatial sound).

• Headlight position/direction, if you enable headlight by TCastleRootTransform.UseHeadlight.

• When X3D nodes change Viewpoint/NavigationInfo (possible if TCastleViewport.AutoCamera), they apply changes to this camera.

• Rendering of TRenderedTextureNode contents (which camera this texture shows).

• At design-time: gizmo size is determined with respect to this camera.

Note that it means that "headlight" done by TCastleRootTransform.UseHeadlight is assigned to one camera in case of multiple viewports looking at the same world. You cannot have a different "headlight" in each viewport, this would cause subtle problems since it's not how it would work in reality (where every light is visible in all viewports), e.g. mirror textures (like GeneratedCubeMapTexture) would need different contents in different viewpoints.

Note that we no longer advise using TCastleRootTransform.UseHeadlight for headlight. It's easier to just place light as child of whatever camera you want, like adding TCastleDirectionalLight as child of TCastleCamera. See examples/viewport_and_scenes/headlight/ . In this case MainCamera doesn't matter, instead you explicitly make headlight by placing light as child of chosen camera.

Note that features like LOD or Billboard or ProximitySensor need to transform this camera to scene local space. Which is not possible if the same scene instance is used multiple times (e.g. under many different TCastleTransform parents). If you need to use these features of TCastleScene, then simply do not use the same scene reference multiple times (instead clone the scene by TCastleScene.Clone).

By default this is set to TCastleViewport.Camera of the TCastleViewport that created this TCastleAbstractRootTransform instance. And if something changes the TCastleViewport.Camera of that viewport, then this MainCamera is also updated. So in simple cases (when you just have one TCastleViewport and add your scenes to it's already-created TCastleViewport.Items) you don't have to do anything, it just works. In general, you can change this to any camera (currently used by some associated TCastleViewport or not), or Nil (in case no camera should be that "central" camera).

Adjust physics properties.

Time scale used when not Paused.

Pausing means that no events (key, mouse, update) are processed. So time doesn't move, and input is not processed.

Navigation also doesn't work (this part is implemented by TCastleViewport and each TCastleNavigation).

This is useful if you want to unconditionally make your world temporary still (for example, useful when entering some modal dialog box and you want the world to behave as a still background).

See also: For other pausing methods, there are other methods of pausing / disabling some events processing for the world:

• You can set TCastleScene.TimePlaying to False. This is roughly equivalent to not running their Update methods. This means that time will "stand still" for them, so their animations will not play. Although they may still react and change in response to mouse clicks / key presses, if TCastleScene.ProcessEvents.

• You can set TCastleScene.ProcessEvents to False. This means that scene will not receive and process any key / mouse and other events (through VRML/X3D sensors). Some animations (not depending on VRML/X3D events processing) may still run, for example MovieTexture will still animate, if only TCastleScene.TimePlaying.

• For navigation, you can set TCastleNavigation.Input := [] to ignore key / mouse clicks.

  Or you can set TCastleNavigation.Exists to False, this is actually equivalent to what pausing does now for TCastleNavigation.