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 ( int update ) #

Arguments

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

Object 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

Shape getIntersection ( Vec3 p0, Vec3 p1, 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

• Vec3 p0 - Start point of the line (in world coordinates).
• Vec3 p1 - End point of the line (in world coordinates).
• 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

int getContactID ( int num ) #

Arguments

• int num - Contact number.

Return value

Vec3 getContactPoint ( int num ) #

Arguments

• int num - Contact number.

Return value

vec3 getContactNormal ( int num ) #

Arguments

• int num - Contact number.

Return value

vec3 getContactVelocity ( int num ) #

Arguments

• int num - Contact number.

Return value

float getContactImpulse ( int num ) #

Arguments

• int num - Contact number.

Return value

float getContactTime ( int num ) #

Arguments

• int num - Contact number.

Return value

float getContactDepth ( int num ) #

Arguments

• int num - Contact number.

Return value

float getContactFriction ( int num ) #

Arguments

• int num - Contact number.

Return value

float getContactRestitution ( int num ) #

Arguments

• int num - Contact number.

Return value

Body getContactBody0 ( int num ) #

Arguments

• int num - Contact number.

Return value

Body getContactBody1 ( int num ) #

Arguments

• int num - Contact number.

Return value

Shape getContactShape0 ( int num ) #

Arguments

• int num - Contact number.

Return value

Shape getContactShape1 ( int num ) #

Arguments

• int num - Contact number.

Return value

Object getContactObject ( int num ) #

Arguments

• int num - Contact number.

Return value

int getContactSurface ( int num ) #

Arguments

• int num - Contact number.

Return value

void setFrozenCallback ( string 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

• string func - Callback function name.

void setPositionCallback ( string 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

• string func - Callback function name.

void setContactCallback ( string 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

setContactCallback("contact_callback_function_name",arg0,arg1);

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

If you want to reposition, transform, create or delete nodes captured by your callback function, you can store them in the array and then perform all necessary operations in the update():

// list of collisions that were processed by other bodies
Body unregistered_collisions[0];

// flag indicating if collisions were detected
int collision_detected = 0;

/*...*/

void contact_callback(Body body, int num)
{
	// collision was detected
	collision_detected = 1;

	// if the collision is processed by other body, adding it to the list
	if (body != this_body)
		unregistered_collisions.append(body);
}

/*...*/

int update()
{
	if (collision_detected)
	{
		// resetting collision flag
		collision_detected = 0;

		for (int i = 0; i < body.getNumContacts(); i++)
		{
			// process all nodes with which collisions were registered
			
			Node node = class_cast("Node",body.getContactObject(i));

			// changing node's rotation
			if (node != NULL)
				node.setRotation(quat(0.0f, 1.0f, 0.0f, 90.0f));
		}
		for (int i = 0; i < unregistered_collisions.size(); i++)
		{
			// process all unregistered collisions
			Node node = class_cast("Node", unregistered_collisions[i].getObject());

			// deleting a node
			if (node != NULL)
				engine.editor.removeNode(node);
        }
		// clearing the list of unregistered collisions after processing them
		unregistered_collisions.clear();
	}
}

Arguments

• string func - Callback function name.

void renderContacts ( ) #

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 ) #

• If a node is a parent for other nodes, states of these child nodes need to be saved manually.
• To save the state from a buffer, file or a message from a socket, make sure the stream is opened. For buffers and files, you also need to set the proper position for reading.

Arguments

• Stream stream - Stream to save node state data.

Return value

int restoreState ( Stream stream ) #

• If a node is a parent for other nodes, states of these child nodes need to be restored manually.
• To save the state into a buffer, file or a message from a socket, make sure the stream is opened. If necessary, you can set a position for writing for buffers and files.

Arguments

• Stream stream - Stream with saved node state data.

Return value