Body Class

Body Class

Members

Body createBody ( int type ) #

Arguments

• int type - Body type. One of the BODY_* values.

Return value

Body createBody ( string type_name ) #

Arguments

• string type_name - Body type name.

Return value

void setID ( int id ) #

Arguments

• int id - Unique ID.

int getID ( ) #

Return value

int getType ( ) #

Return value

string getTypeName ( ) #

Return value

string getTypeName ( int type ) #

Arguments

• int type - Body type ID. One of the BODY_* values.

Return value

void setObject ( bool update ) #

Arguments

• bool update - Update flag: 1 to update the object after assigning the body (by default), 0 not to update right after body assignment.

getObject ( ) #

Return value

void setEnabled ( int enable ) #

Arguments

• int enable - 1 to enable physical interactions, 0 to disable them.

int isEnabled ( ) #

Return value

int isEnabledSelf ( ) #

Return value

void setFrozen ( int frozen ) #

Arguments

• int frozen - 1 to freeze the object, 0 to unfreeze it.

int isFrozen ( ) #

Return value

void setImmovable ( int immovable ) #

Arguments

• int immovable - 1 if the body is immovable (static); otherwise, 0.

int isImmovable ( ) #

Return value

void setGravity ( int gravity ) #

Arguments

• int gravity - 1 if the body is affected by gravity; otherwise, 0.

int isGravity ( ) #

Return value

void setName ( string name ) #

Arguments

• string name - Name of the body.

string getName ( ) #

Return value

void setPhysicalMask ( int mask ) #

Arguments

• int mask - Integer, each bit of which is a mask.

int getPhysicalMask ( ) #

Return value

void setTransform ( Mat4 transform ) #

Arguments

• Mat4 transform - Transformation matrix. This matrix describes position, orientation and scale of the body.

Mat4 getTransform ( ) #

Return value

void setPreserveTransform ( Mat4 transform ) #

Arguments

• Mat4 transform - Transformation matrix. This matrix describes position, orientation and scale of the body.

void setVelocityTransform ( Mat4 transform ) #

Arguments

• Mat4 transform - Transformation matrix. This matrix describes position, orientation and scale of the body.

void flushTransform ( ) #

void setPosition ( Vec3 pos ) #

Arguments

• Vec3 pos - New position in the world coordinates.

Vec3 getPosition ( ) #

Return value

void setRotation ( quat rot ) #

Arguments

• quat rot - New rotation in the world coordinates.

quat getRotation ( ) #

Return value

void setDirection ( vec3 dir, vec3 up ) #

Arguments

• vec3 dir - New direction vector in the world coordinates. The direction vector always has unit length.
• vec3 up - New up vector in the world coordinates.

vec3 getDirection ( ) #

Return value

Body getParent ( ) #

Return value

int isChild ( Body body ) #

Arguments

• Body body - Body to check.

Return value

int getNumChildren ( ) #

Return value

int findChild ( string name ) #

Arguments

• string name - Name of the child body.

Return value

Body getChild ( int num ) #

Arguments

• int num - Child number.

Return value

void addShape ( Shape shape, mat4 transform ) #

Arguments

• Shape shape - New shape to add.
• mat4 transform - Shape transformation matrix (in the body's coordinate system).

void addShape ( Shape shape ) #

Arguments

• Shape shape - New shape to add.

void clearShapes ( int destroy = 0 ) #

Arguments

• int destroy - Flag indicating whether shapes are to be destroyed after removal: use 1 to destroy shapes after removal, or 0 if you plan to use them later. The default value is 0.

int isShape ( Shape shape ) #

Arguments

• Shape shape - Shape to check.

Return value

int insertShape ( int pos, Shape shape ) #

Arguments

• int pos - Position in the list at which the shape is to be inserted in the range from 0 to the number of shapes.
• Shape shape - Shape to be inserted.

Return value

int insertShape ( int pos, Shape shape, mat4 transform ) #

Arguments

• int pos - Position in the list at which the shape is to be inserted in the range from 0 to the number of shapes.
• Shape shape - Shape to be inserted.
• mat4 transform - Shape's transformation (in the body's coordinate system).

Return value

int getNumShapes ( ) #

Return value

int findShape ( string name ) #

Arguments

• string name - Name of the shape.

Return value

Shape getShape ( int num ) #

Arguments

• int num - Shape number.

Return value

void setShapeTransform ( int num, mat4 transform ) #

Arguments

• int num - Shape number.
• mat4 transform - Transformation matrix (in the body's coordinate system).

mat4 getShapeTransform ( int num ) #

Arguments

• int num - Shape number.

Return value

void updateShapes ( ) #

void addJoint ( Joint joint ) #

Arguments

• Joint joint - New joint to add.

void removeJoint ( ) #

Arguments

void insertJoint ( Joint joint, int num ) #

Arguments

• Joint joint - Joint to be inserted.
• int num - Position in the list at which the joint is to be inserted in the range from 0 to the number of joints.

int isJoint ( Joint joint ) #

Arguments

• Joint joint - Joint to check.

Return value

int getNumJoints ( ) #

Return value

int findJoint ( string name ) #

Arguments

• string name - Name of the joint.

Return value

Joint getJoint ( int num ) #

Arguments

• int num - Joint number.

Return value

getIntersection ( int mask, variable v ) #

Performs tracing from the p0 point to the p1 point to find a body shape intersected by this line. Intersection is found only for objects with a matching intersection mask. On success ret_point and ret_normal shall contain information about intersection.

Depending on the variable passed as an argument, the result can be presented as a PhysicsIntersection or PhysicsIntersectionNormal class instance.

Arguments

• int mask - Intersection mask.
• variable v - Variable defining which type of intersection object will be returned:
  • PhysicsIntersection intersection — PhysicsIntersection class instance containing intersection information (contact point coordinates).
  • PhysicsIntersectionNormal normal — PhysicsIntersectionNormal class instance containing intersection information (contact point and normal coordinates).

Return value

int getNumContacts ( ) #

Return value

long getContactID ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

int findContactByID ( long id ) #

Arguments

• long id - Contact ID.

Return value

int isContactInternal ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

int isContactEnter ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

int isContactLeave ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

int isContactStay ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

Vec3 getContactPoint ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

vec3 getContactNormal ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

vec3 getContactVelocity ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

float getContactImpulse ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

float getContactTime ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

float getContactDepth ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

float getContactFriction ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

float getContactRestitution ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

Body getContactBody0 ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

Body getContactBody1 ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

Shape getContactShape0 ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

Shape getContactShape1 ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

Object getContactObject ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

int getContactSurface ( int num ) #

Arguments

• int num - Contact number in the range from 0 to the total number of contacts.

Return value

void setFrozenCallback ( int func ) #

Adds a callback function to be called when a given body freezes.

The signature of the frozen callback function must be as follows:

void frozen_callback_function_name(Body body);

You can set a callback function as follows:

setFrozenCallback("frozen_callback_function_name");

Example: Setting a body frozen callback function for a certain class:

class SomeClass
{
	// body for which a frozen callback function is to be set
	Body body;

	/*...*/

	// callback function
	void on_frozen(Body body)
	{
		// insert your code handling freezing here
	}

	void registerCallback()
	{
		// setting the on_frozen() function to handle freezing for the body
		body.setFrozenCallback("SomeClass::on_frozen");
	}
	
	/*...*/
};

Arguments

• int func - Callback function name.

void setPositionCallback ( int func ) #

Adds a callback function to be called when a given body moves a certain distance (rotation is not taken into account).

The signature of the position callback function must be as follows:

void position_callback_function_name(Body body);

You can set a callback function as follows:

setPositionCallback("position_callback_function_name");

Example: Setting a body position callback function for a certain class:

class SomeClass
{
	// body for which a position callback function is to be set
	Body body;

	/*...*/

	// callback function
	void on_position(Body body)
	{
		// insert your code handling position changes here
	}

	void registerCallback()
	{
		// setting the on_position() function to handle position changes for the body
		body.addPositionCallback("SomeClass::on_position");
	}
	
	/*...*/
};

Arguments

• int func - Callback function name.

void setContactsCallback ( int func ) #

contacts_callback_function_name(Body body);
contacts_callback_function_name(Body body,int num); // num is the contact ID
contacts_callback_function_name(Body body,int num,variable arg0); // num is the contact ID
contacts_callback_function_name(Body body,int num,variable arg0,variable arg1); // num is the contact ID

setContactsCallback("contacts_callback_function_name",arg0,arg1);

contacts_callback_function_name(Body body,int num,variable arg0,variable arg1);

Arguments

• int func - Callback function name.

void setContactEnterCallback ( int func ) #

contact_callback_function_name(Body body);
contact_callback_function_name(Body body,int num); // num is the contact ID
contact_callback_function_name(Body body,int num,variable arg0); // num is the contact ID
contact_callback_function_name(Body body,int num,variable arg0,variable arg1); // num is the contact ID

setContactEnterCallback("contact_enter_callback_function_name",arg0,arg1);

contact_enter_callback_function_name(Body body,int num,variable arg0,variable arg1);

Arguments

• int func - Callback function name.

void setContactLeaveCallback ( int func ) #

contact_callback_function_name(Body body);
contact_callback_function_name(Body body,int num); // num is the contact ID
contact_callback_function_name(Body body,int num,variable arg0); // num is the contact ID
contact_callback_function_name(Body body,int num,variable arg0,variable arg1); // num is the contact ID

setContactLeaveCallback("contact_leave_callback_function_name",arg0,arg1);

contact_leave_callback_function_name(Body body,int num,variable arg0,variable arg1);

Arguments

• int func - Callback function name.

void renderContacts ( ) #

void renderExternalContacts ( ) #

void renderInternalContacts ( ) #

void renderJoints ( ) #

void renderShapes ( ) #

void renderVisualizer ( ) #

Body clone ( Object object ) #

Arguments

• Object object - Object, to which the copy will be assigned.

Return value

void swap ( Body body ) #

Arguments

• Body body - Body to swap.

int saveState ( Stream stream ) #

Example using saveState() and restoreState() methods:

// set the body state
body.setPosition(vec3(1, 1, 0));

// save state
Blob blob_state = new Blob();
body.saveState(blob_state);

// change state
body.setPosition(vec3(0, 0, 0));

// restore state
blob_state.seekSet(0); // returning the carriage to the start of the blob
body.restoreState(blob_state);

Arguments

• Stream stream - Stream to save body state data.

Return value

int restoreState ( Stream stream ) #

Example using saveState() and restoreState() methods:

// set the body state
body.setPosition(vec3(1, 1, 0));

// save state
Blob blob_state = new Blob();
body.saveState(blob_state);

// change state
body.setPosition(vec3(0, 0, 0));

// restore state
blob_state.seekSet(0); // returning the carriage to the start of the blob
body.restoreState(blob_state);

Arguments

• Stream stream - Stream with saved body state data.

Return value