struct MAGES::MeshDeformations::CollinearConstraint¶

Overview¶

A constraint that tries to keep 3 particles collinear. More…

struct CollinearConstraint
{
    // fields

    bool Enabled;
    bool Breakable;
    int ParticleA;
    int ParticleB;
    int ParticleC;
    int PhysicsMaterialIndex;

    // methods

    CollinearConstraint(int particleA, int particleB, int particleC);

    CollinearConstraint(
        int particleA,
        int particleB,
        int particleC,
        int physicsMaterial
    );

    CollinearConstraint(
        int particleA,
        int particleB,
        int particleC,
        bool breakable,
        bool enabled = true
    );
};

Detailed Documentation¶

A constraint that tries to keep 3 particles collinear.

Fields¶

bool Enabled

Defines whether this constraint is enabled.

bool Breakable

Defines whether this constraint can be broken.

int ParticleA

Particle A index.

int ParticleB

Particle B index.

int ParticleC

Particle C index.

int PhysicsMaterialIndex

Physics material index.

Methods¶

CollinearConstraint(int particleA, int particleB, int particleC)

Initializes a new instance of the CollinearConstraint struct.

Parameters:

particleA	ParticleA index.
particleB	ParticleB index.
particleC	ParticleC index.

CollinearConstraint(
    int particleA,
    int particleB,
    int particleC,
    int physicsMaterial
)

Initializes a new instance of the CollinearConstraint struct.

Parameters:

particleA	ParticleA index.
particleB	ParticleB index.
particleC	ParticleC index.
physicsMaterial	Physics material index.

CollinearConstraint(
    int particleA,
    int particleB,
    int particleC,
    bool breakable,
    bool enabled = true
)

Initializes a new instance of the CollinearConstraint struct.

Parameters:

particleA	ParticleA index.
particleB	ParticleB index.
particleC	ParticleC index.
breakable	Defines whether this constraint can be broken.
enabled	Whether this constraint is enabled.