Drag[en]gine Script Module DragonScript Script API  1.0
ColliderConstraint Class Reference

Collider constraint. More...

Inheritance diagram for ColliderConstraint:

Public Member Functions

Constructors
ColliderConstraint new ()
 Create collider constraint. More...
 
Management
Collider getTargetCollider ()
 Target collider or null to target the world. More...
 
void setTargetCollider (Collider collider)
 Set target collider or null to target the world. More...
 
String getTargetBone ()
 Taret bone or empty string if not targeting a bone. More...
 
void setTargetBone (String bone)
 Set target bone or empty string if not targeting a bone. More...
 
Vector getPosition1 ()
 Position of the reference coordinate system. More...
 
void setPosition1 (Vector position)
 Set position of the reference coordinate system. More...
 
Quaternion getOrientation1 ()
 Orientation of the reference coordinate system. More...
 
void setOrientation1 (Quaternion orientation)
 Set orientation of the reference coordinate system. More...
 
Vector getPosition2 ()
 Position of the reference coordinate system. More...
 
void setPosition2 (Vector position)
 Set position of the reference coordinate system. More...
 
Quaternion getOrientation2 ()
 Orientation of the reference coordinate system. More...
 
void setOrientation2 (Quaternion orientation)
 Set orientation of the reference coordinate system. More...
 
int getBone ()
 Bone index or -1 if attached to the entire component. More...
 
void setBone (int bone)
 Set bone index or -1 if attached to the entire component. More...
 
Degree of freedom (DOF) limits
float getLowerLimitFor (int degreeOfFreedom)
 Lower limit for DOF. More...
 
float getUpperLimitFor (int degreeOfFreedom)
 Upper limit for DOF. More...
 
void setLimitsFor (int degreeOfFreedom, float lowerLimit, float upperLimit)
 Set lower and upper limit. More...
 
void setLockedFor (int degreeOfFreedom)
 Set given DOF to locked. More...
 
void setFreeFor (int degreeOfFreedom)
 Set given DOF free. More...
 
Vector getLinearLowerLimits ()
 Lower limits for all linear DOFs as a vector. More...
 
Vector getLinearUpperLimits ()
 Upper limits for all linear DOFs as a vector. More...
 
void setLinearLimits (Vector lowerLimits, Vector upperLimits)
 Set limits for linear all linear DOFs from vectors. More...
 
Vector getAngularLowerLimits ()
 Lower limits for all angular DOFs as a vector. More...
 
Vector getAngularUpperLimits ()
 Upper limits for all angular DOFs as a vector. More...
 
void setAngularLimits (Vector lowerLimits, Vector upperLimits)
 Set limits for angular all angular DOFs from vectors. More...
 
void lockAll ()
 Lock all DOFs. More...
 
void setToBallJoint ()
 Lock all linear DOFs and sets all angular DOFs free. More...
 
void setToHingeJoint (int degreeOfFreedom, float lowerLimit, float upperLimit)
 Set upper and lower limit for the given angular DOF and locks all others. More...
 
void setPistonJoint (int degreeOfFreedom, float lowerLimit, float upperLimit)
 Set upper and lower limit for the given linear DOF and locks all others. More...
 
Degree of freedom (DOF) damping
float getLinearDamping ()
 Linear damping for DOF. More...
 
void setLinearDamping (float damping)
 Set linear damping for DOF. More...
 
float getAngularDamping ()
 Angular damping for DOF. More...
 
void setAngularDamping (float damping)
 Set angular damping for DOF. More...
 
float getSpringDamping ()
 Spring damping for DOF. More...
 
void setSpringDamping (float damping)
 Set spring damping for DOF. More...
 
Rope
bool getIsRope ()
 Use rope physics. More...
 
void setIsRope (bool isRope)
 Set use rope physics. More...
 
Breaking
float getBreakingThreshold ()
 Breaking threshold impulse. More...
 
void setBreakingThreshold (float impuls)
 Set breaking threshold impulse. More...
 

Static Public Attributes

Degrees of freedom.
static final int LINEAR_X = 0
 Linear X axis. More...
 
static final int LINEAR_Y = 1
 Linear Y axis. More...
 
static final int LINEAR_Z = 2
 Linear Z axis. More...
 
static final int ANGULAR_X = 3
 Angular X axis. More...
 
static final int ANGULAR_Y = 4
 Angular Y axis. More...
 
static final int ANGULAR_Z = 5
 Angular Z axis. More...
 

Detailed Description

Collider constraint.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getAngularDamping()

float getAngularDamping ( )

Angular damping for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ getAngularLowerLimits()

Vector getAngularLowerLimits ( )

Lower limits for all angular DOFs as a vector.

§ getAngularUpperLimits()

Vector getAngularUpperLimits ( )

Upper limits for all angular DOFs as a vector.

§ getBone()

int getBone ( )

Bone index or -1 if attached to the entire component.

§ getBreakingThreshold()

float getBreakingThreshold ( )

Breaking threshold impulse.

§ getIsRope()

bool getIsRope ( )

Use rope physics.

§ getLinearDamping()

float getLinearDamping ( )

Linear damping for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ getLinearLowerLimits()

Vector getLinearLowerLimits ( )

Lower limits for all linear DOFs as a vector.

§ getLinearUpperLimits()

Vector getLinearUpperLimits ( )

Upper limits for all linear DOFs as a vector.

§ getLowerLimitFor()

float getLowerLimitFor ( int  degreeOfFreedom)

Lower limit for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ getOrientation1()

Quaternion getOrientation1 ( )

Orientation of the reference coordinate system.

§ getOrientation2()

Quaternion getOrientation2 ( )

Orientation of the reference coordinate system.

§ getPosition1()

Vector getPosition1 ( )

Position of the reference coordinate system.

§ getPosition2()

Vector getPosition2 ( )

Position of the reference coordinate system.

§ getSpringDamping()

float getSpringDamping ( )

Spring damping for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ getTargetBone()

String getTargetBone ( )

Taret bone or empty string if not targeting a bone.

§ getTargetCollider()

Collider getTargetCollider ( )

Target collider or null to target the world.

§ getUpperLimitFor()

float getUpperLimitFor ( int  degreeOfFreedom)

Upper limit for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ lockAll()

void lockAll ( )

Lock all DOFs.

§ new()

Create collider constraint.

§ setAngularDamping()

void setAngularDamping ( float  damping)

Set angular damping for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ setAngularLimits()

void setAngularLimits ( Vector  lowerLimits,
Vector  upperLimits 
)

Set limits for angular all angular DOFs from vectors.

§ setBone()

void setBone ( int  bone)

Set bone index or -1 if attached to the entire component.

§ setBreakingThreshold()

void setBreakingThreshold ( float  impuls)

Set breaking threshold impulse.

§ setFreeFor()

void setFreeFor ( int  degreeOfFreedom)

Set given DOF free.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ setIsRope()

void setIsRope ( bool  isRope)

Set use rope physics.

§ setLimitsFor()

void setLimitsFor ( int  degreeOfFreedom,
float  lowerLimit,
float  upperLimit 
)

Set lower and upper limit.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ setLinearDamping()

void setLinearDamping ( float  damping)

Set linear damping for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ setLinearLimits()

void setLinearLimits ( Vector  lowerLimits,
Vector  upperLimits 
)

Set limits for linear all linear DOFs from vectors.

§ setLockedFor()

void setLockedFor ( int  degreeOfFreedom)

Set given DOF to locked.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ setOrientation1()

void setOrientation1 ( Quaternion  orientation)

Set orientation of the reference coordinate system.

§ setOrientation2()

void setOrientation2 ( Quaternion  orientation)

Set orientation of the reference coordinate system.

§ setPistonJoint()

void setPistonJoint ( int  degreeOfFreedom,
float  lowerLimit,
float  upperLimit 
)

Set upper and lower limit for the given linear DOF and locks all others.

§ setPosition1()

void setPosition1 ( Vector  position)

Set position of the reference coordinate system.

§ setPosition2()

void setPosition2 ( Vector  position)

Set position of the reference coordinate system.

§ setSpringDamping()

void setSpringDamping ( float  damping)

Set spring damping for DOF.

Exceptions
EInvalidParamdegreeOfFreedom is not a valid value.

§ setTargetBone()

void setTargetBone ( String  bone)

Set target bone or empty string if not targeting a bone.

§ setTargetCollider()

void setTargetCollider ( Collider  collider)

Set target collider or null to target the world.

§ setToBallJoint()

void setToBallJoint ( )

Lock all linear DOFs and sets all angular DOFs free.

§ setToHingeJoint()

void setToHingeJoint ( int  degreeOfFreedom,
float  lowerLimit,
float  upperLimit 
)

Set upper and lower limit for the given angular DOF and locks all others.

Member Data Documentation

§ ANGULAR_X

final int ANGULAR_X = 3
static

Angular X axis.

§ ANGULAR_Y

final int ANGULAR_Y = 4
static

Angular Y axis.

§ ANGULAR_Z

final int ANGULAR_Z = 5
static

Angular Z axis.

§ LINEAR_X

final int LINEAR_X = 0
static

Linear X axis.

§ LINEAR_Y

final int LINEAR_Y = 1
static

Linear Y axis.

§ LINEAR_Z

final int LINEAR_Z = 2
static

Linear Z axis.


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