VerletPhysics.VerletChainBuilder Class Reference

Simple verlet chain builder. Uses a PointConfiguratorFunc to configure VerletPoints on creation. More...

Public Member Functions
delegate void	PointConfiguratorFunc (VerletPoint point)
	Point configuration function definition More...
	VerletChainBuilder (VerletWorld world, bool pinFirst=true, bool pinLast=false, bool drawIntermediatePoints=false)
	Create a verlet chain builder. More...
VerletChainBuilder	AddPointAtPosition (float x, float y, PointConfiguratorFunc configurator=null)
	Add chain point at a specific position. More...
VerletChainBuilder	AddPointAtPosition (Vector2 position, PointConfiguratorFunc configurator=null)
	Add chain point at a specific position. More...
VerletChainBuilder	AddPointWithOffset (float x, float y, PointConfiguratorFunc configurator=null)
	Add chain point with offset from previous point position. If not already set, the first point will be offset from (0, 0). More...
VerletChainBuilder	AddPointWithOffset (Vector2 offset, PointConfiguratorFunc configurator=null)
	Add chain point with offset from previous point position. If not already set, the first point will be offset from (0, 0). More...
VerletChainBuilder	AddPointsWithOffset (int pointCount, float x, float y, PointConfiguratorFunc configurator=null)
	Add multiple chain points with offset from previous points positions. If not already set, the first point will be offset from (0, 0). More...
VerletChainBuilder	AddPointsWithOffset (int pointCount, Vector2 offset, PointConfiguratorFunc configurator=null)
	Add multiple chain points with offset from previous points positions. If not already set, the first point will be offset from (0, 0). More...
void	Build (float restingDistance=50, float tearSensitivity=100, float stiffness=1)
	Build the verlet chain. More...

Detailed Description

Simple verlet chain builder. Uses a PointConfiguratorFunc to configure VerletPoints on creation.

Definition at line 14 of file VerletChainBuilder.cs.

Constructor & Destructor Documentation

VerletChainBuilder()

VerletPhysics.VerletChainBuilder.VerletChainBuilder ( VerletWorld  world, bool  pinFirst = true, bool  pinLast = false, bool  drawIntermediatePoints = false  )

inline

Create a verlet chain builder.

Parameters

world	Verlet world
pinFirst	Pin first chain point
pinLast	Pin last chain point
drawIntermediatePoints	Draw chain intermediate points

Definition at line 32 of file VerletChainBuilder.cs.

        {
            this.world = world;
            this.pinFirst = pinFirst;
            this.pinLast = pinLast;
            this.drawIntermediatePoints = drawIntermediatePoints;
            points = new List<VerletPoint>();
        }

Member Function Documentation

AddPointAtPosition() [1/2]

VerletChainBuilder VerletPhysics.VerletChainBuilder.AddPointAtPosition ( float  x, float  y, PointConfiguratorFunc  configurator = null  )

inline

Add chain point at a specific position.

Parameters

x	X coordinate
y	Y coordinate
configurator	Point configurator

Returns

Builder

Definition at line 48 of file VerletChainBuilder.cs.

        {
            return AddPointAtPosition(new Vector2(x, y), configurator);
        }

AddPointAtPosition() [2/2]

VerletChainBuilder VerletPhysics.VerletChainBuilder.AddPointAtPosition ( Vector2  position, PointConfiguratorFunc  configurator = null  )

inline

Add chain point at a specific position.

Parameters

position	Position vector
configurator	Point configurator

Returns

Builder

Definition at line 59 of file VerletChainBuilder.cs.

        {
            var point = world.CreatePoint();
            point.MoveToPosition(position);
 
            if (points.Count == 0 && pinFirst)
            {
                point.PinToCurrentPosition();
            }
            else if (!drawIntermediatePoints)
            {
                point.Visible = false;
            }
 
            configurator?.Invoke(point);
            points.Add(point);
            return this;
        }

AddPointsWithOffset() [1/2]

VerletChainBuilder VerletPhysics.VerletChainBuilder.AddPointsWithOffset ( int  pointCount, float  x, float  y, PointConfiguratorFunc  configurator = null  )

inline

Add multiple chain points with offset from previous points positions. If not already set, the first point will be offset from (0, 0).

Parameters

pointCount	Point count
x	X offset
y	Y offset
configurator	Point configurator

Returns

Builder

Definition at line 118 of file VerletChainBuilder.cs.

        {
            return AddPointsWithOffset(pointCount, new Vector2(x, y), configurator);
        }

AddPointsWithOffset() [2/2]

VerletChainBuilder VerletPhysics.VerletChainBuilder.AddPointsWithOffset ( int  pointCount, Vector2  offset, PointConfiguratorFunc  configurator = null  )

inline

Add multiple chain points with offset from previous points positions. If not already set, the first point will be offset from (0, 0).

Parameters

pointCount	Point count
offset	Offset vector
configurator	Point configurator

Returns

Builder

Definition at line 131 of file VerletChainBuilder.cs.

        {
            var builder = this;
            for (int i = 0; i < pointCount; ++i)
            {
                builder = builder.AddPointWithOffset(offset, configurator);
            }
            return builder;
        }

AddPointWithOffset() [1/2]

VerletChainBuilder VerletPhysics.VerletChainBuilder.AddPointWithOffset ( float  x, float  y, PointConfiguratorFunc  configurator = null  )

inline

Add chain point with offset from previous point position. If not already set, the first point will be offset from (0, 0).

Parameters

x	X coordinate
y	Y coordinate
configurator	Point configurator

Returns

Builder

Definition at line 86 of file VerletChainBuilder.cs.

        {
            return AddPointWithOffset(new Vector2(x, y), configurator);
        }

AddPointWithOffset() [2/2]

VerletChainBuilder VerletPhysics.VerletChainBuilder.AddPointWithOffset ( Vector2  offset, PointConfiguratorFunc  configurator = null  )

inline

Add chain point with offset from previous point position. If not already set, the first point will be offset from (0, 0).

Parameters

offset	Offset vector
configurator	Point configurator

Returns

Builder

Definition at line 98 of file VerletChainBuilder.cs.

        {
            Vector2 prevPosition = Vector2.Zero;
            if (points.Count > 0)
            {
                prevPosition = points[^1].GlobalPosition;
            }
 
            return AddPointAtPosition(prevPosition + offset, configurator);
        }

Build()

void VerletPhysics.VerletChainBuilder.Build ( float  restingDistance = 50, float  tearSensitivity = 100, float  stiffness = 1  )

inline

Build the verlet chain.

Parameters

restingDistance	Resting distance
tearSensitivity	Distance required to break the chain. Use -1 to create an unbreakable chain.
stiffness	Stiffness of the chain

Definition at line 147 of file VerletChainBuilder.cs.

        {
            if (points.Count < 2)
            {
                GD.PrintErr("Bad points length for chain. Need to be >= 2");
                return;
            }
 
            // Pin last
            var lastPoint = points[^1];
            if (pinLast)
            {
                lastPoint.PinToCurrentPosition();
            }
 
            // Show last
            lastPoint.Visible = true;
 
            VerletPoint prevPoint = points[0];
            for (int i = 1; i < points.Count; ++i)
            {
                var currPoint = points[i];
 
                var link = world.CreateLink(prevPoint, currPoint);
                link.RestingDistance = restingDistance;
                link.TearSensitivity = tearSensitivity;
                link.Stiffness = stiffness;
 
                prevPoint = currPoint;
            }
        }

PointConfiguratorFunc()

delegate void VerletPhysics.VerletChainBuilder.PointConfiguratorFunc

(

VerletPoint

point

)

Point configuration function definition

---

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

• scripts/verletphysics/VerletChainBuilder.cs