Torque 3D - Script Manual: PxMultiActorData Class Reference

TorqueScript

Main   Class List   Namespace List   Online

PxMultiActorData Class Reference
[Physics]

Defines the properties of a type of PxMultiActor. More...

Inheritance diagram for PxMultiActorData:

List of all members.

Public Attributes

float breakForce
 Force required to break an actor.
bool clientOnly
 
void dumpModel
 Dumps model hierarchy and details to a file.
void reload
 Reloads all data used for the PxMultiActorData.
bool singlePlayerOnly
 
Physics

float angularDrag
 Value used to help calculate rotational drag force while submerged in water.
float buoyancyDensity
 The density used to calculate buoyant forces.
float linearDrag
 Value used to help calculate linear drag force while submerged in water.
PxMaterial Material
 An optional PxMaterial to be used for the PxMultiActor.
bool noCorrection
 
filename physXStream
 .XML file containing data such as actors, shapes, and joints.
 string
 
float waterDragScale
 Scale to apply to linear and angular dampening while submerged in water.
Media

filename shapeName
 Path to the .DAE or .DTS file to render.

Detailed Description

Defines the properties of a type of PxMultiActor.

Usually it is prefered to use PhysicsShape rather than PxMultiActor because a PhysicsShape is not PhysX specific and can be much easier to setup.

For more information, refer to Nvidia's PhysX docs.


Member Data Documentation

Value used to help calculate rotational drag force while submerged in water.

Force required to break an actor.

This value does not apply to joints. If an actor is associated with a joint it will break whenever the joint does. This allows an actor "not" associated with a joint to also be breakable.

The density used to calculate buoyant forces.

The result of the calculated buoyancy is relative to the density of the WaterObject the PxMultiActor is within.

Note:
This value is necessary because Torque 3D does its own buoyancy simulation. It is not handled by PhysX.
See also:
WaterObject::density

Dumps model hierarchy and details to a file.

The file will be created as 'model.dump' in the game folder. If model.dump already exists, it will be overwritten.

Value used to help calculate linear drag force while submerged in water.

An optional PxMaterial to be used for the PxMultiActor.

Defines properties such as friction and restitution. Unrelated to the material used for rendering. The physXStream will contain defined materials that can be customized in 3DS Max. To override the material for all physics shapes in the physXStream, specify a material here.

.XML file containing data such as actors, shapes, and joints.

These files can be created using a free PhysX plugin for 3DS Max.

Reloads all data used for the PxMultiActorData.

If the reload sucessfully completes, all PxMultiActor's will be notified.

Path to the .DAE or .DTS file to render.

Scale to apply to linear and angular dampening while submerged in water.



Copyright © GarageGames, LLC. All Rights Reserved.