SoftBody3D

public uint CollisionLayer { get; set; }

The physics layers this SoftBody3D is in. Collision objects can exist in one or more of 32 different layers. See also SoftBody3D.CollisionMask. Note: Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See Collision layers and masks in the documentation for more information.

public uint CollisionMask { get; set; }

The physics layers this SoftBody3D scans. Collision objects can scan one or more of 32 different layers. See also SoftBody3D.CollisionLayer. Note: Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See Collision layers and masks in the documentation for more information.

public float DampingCoefficient { get; set; }

The body's damping coefficient. Higher values will slow down the body more noticeably when forces are applied.

public SoftBody3D.DisableModeEnum DisableMode { get; set; }

Defines the behavior in physics when Entity.ProcessMode is set to Entity.ProcessModeEnum.Disabled.

public float DragCoefficient { get; set; }

The body's drag coefficient. Higher values increase this body's air resistance. Note: This value is currently unused by Reckfell's default physics implementation.

public float LinearStiffness { get; set; }

A deformation-resistance coefficient. The same value does not guarantee equal results across topology, timestep or backend. Begin with a simple mesh and test deformation/cost.

public EntityPath ParentCollisionIgnore { get; set; }

A path used to exclude the corresponding parent physics object from collisions. It does not pin cloth to a skeleton or generally replace Layer/Mask.

public int PointCount { get; }

The current Mesh first-surface vertex count. This alone does not prove an arbitrary body has entered a physics space or started updating points.

public float PressureCoefficient { get; set; }

The pressure coefficient of this soft body. Simulate pressure build-up from inside this body. Higher values increase the strength of this effect.

public bool RayPickable { get; set; }

If true, the SoftBody3D will respond to RayCast3Ds.

public float ShrinkingFactor { get; set; }

Scales the rest lengths of SoftBody3D's edge constraints. Positive values shrink the mesh, while negative values expand it. For example, a value of 0.1 shortens the edges of the mesh by 10%, while -0.1 expands the edges by 10%. Note: SoftBody3D.ShrinkingFactor is best used on surface meshes with pinned points.

public int SimulationPrecision { get; set; }

Increasing this value will improve the resulting simulation, but can affect performance. Use with care.

public float TotalMass { get; set; }

The SoftBody3D's mass.

public void AddCollisionExceptionWith(Entity body);

Adds a body to the list of bodies that this body can't collide with.

public void ApplyCentralForce(Vector3 force);

Distributes and applies a force to all points. A force is time dependent and meant to be applied every physics update.

public void ApplyCentralImpulse(Vector3 impulse);

Distributes and applies an impulse to all points. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).

public void ApplyForce(int pointIndex, Vector3 force);

Applies a force to a point. A force is time dependent and meant to be applied every physics update.

public void ApplyImpulse(int pointIndex, Vector3 impulse);

Applies an impulse to a point. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).

public Reckfell.Collections.Array<PhysicsBody3D> GetCollisionExceptions();

Returns an array of nodes that were added as collision exceptions for this body.

public bool GetCollisionLayerValue(int layerNumber);

Returns whether or not the specified layer of the SoftBody3D.CollisionLayer is enabled, given a layer_number between 1 and 32.

public bool GetCollisionMaskValue(int layerNumber);

Returns whether or not the specified layer of the SoftBody3D.CollisionMask is enabled, given a layer_number between 1 and 32.

public Rid GetPhysicsRid();

Returns the internal Rid used by the PhysicsServer3D for this body.

public Vector3 GetPointTransform(int pointIndex);

Returns a physics point world position despite Transform in its name. Check the index and body membership in a physics world; this is not an ordinary entity transform.

public bool IsPointPinned(int pointIndex);

Returns true if vertex is set to pinned.

public void RemoveCollisionExceptionWith(Entity body);

Removes a body from the list of bodies that this body can't collide with.

public void SetCollisionLayerValue(int layerNumber, bool value);

Based on value, enables or disables the specified layer in the SoftBody3D.CollisionLayer, given a layer_number between 1 and 32.

public void SetCollisionMaskValue(int layerNumber, bool value);

Based on value, enables or disables the specified layer in the SoftBody3D.CollisionMask, given a layer_number between 1 and 32.

public void SetPointPinned(int pointIndex, bool pinned, EntityPath attachmentPath);

Pins/unpins a point by index; attachmentPath optionally identifies an attachment entity. Validate range and mesh topology. Indices can change after reimport/optimization; pinning does not replace collision filters.

public void SetPointPinned(int pointIndex, bool pinned, EntityPath attachmentPath = null, int insertAt = -1);

Pins/unpins a point by index; attachmentPath optionally identifies an attachment entity. Validate range and mesh topology. Indices can change after reimport/optimization; pinning does not replace collision filters.