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

Force field. More...

Inheritance diagram for ForceField:

Public Member Functions

Constructors
ForceField new ()
 Create force field. More...
 
Management
DVector getPosition ()
 Position. More...
 
void setPosition (DVector position)
 Set position. More...
 
Quaternion getOrientation ()
 Orientation. More...
 
void setOrientation (Quaternion orientation)
 Set orientation. More...
 
ShapeList getInfluenceArea ()
 Influence area. More...
 
void setInfluenceArea (ShapeList area)
 Set influence area. More...
 
float getRadius ()
 Falloff radius. More...
 
void setRadius (float radius)
 Set falloff radius. More...
 
float getExponent ()
 Falloff exponent. More...
 
void setExponent (float exponent)
 Set falloff exponent. More...
 
int getFieldType ()
 Field type. More...
 
void setFieldType (int type)
 Set field type. More...
 
void setApplicationType (int type)
 Set application type. More...
 
Vector getDirection ()
 Force direction. More...
 
void setDirection (Vector direction)
 Set force direction. More...
 
float getForce ()
 Force in newton. More...
 
void setForce (float force)
 Set force in newton. More...
 
float getFluctuationDirection ()
 Fluctuation of direction in radians. More...
 
void setFluctuationDirection (float fluctuation)
 Set fluctuation of direction in radians. More...
 
float getFluctuationForce ()
 Fluctuation of force in newton. More...
 
void setFluctuationForce (float fluctuation)
 Set fluctuation of force in newton. More...
 
CollisionFilter getCollisionFilter ()
 Collision filter. More...
 
void setCollisionFilter (CollisionFilter filter)
 Set collision filter. More...
 
bool getEnabled ()
 Force field is enabled. More...
 
void setEnabled (bool enabled)
 Set if force field is enabled. More...
 

Static Public Attributes

Field type constants
static final int RADIAL = 0
 Force is applied radial from the center. More...
 
static final int LINEAR = 1
 Force is applied along the force direction. More...
 
static final int VORTEX = 2
 Force is applied vortex like swirling around. More...
 
static final int DIRECT = 0
 Force application types. More...
 
static final int SURFACE = 1
 Apply force on exposed surface area. More...
 
static final int MASS = 2
 Apply force on mass. More...
 
static final int SPEED = 3
 Apply force relative to speed of element. More...
 

Detailed Description

Force field.

This is a native class.

Member Function Documentation

§ getCollisionFilter()

CollisionFilter getCollisionFilter ( )

Collision filter.

§ getDirection()

Vector getDirection ( )

Force direction.

§ getEnabled()

bool getEnabled ( )

Force field is enabled.

§ getExponent()

float getExponent ( )

Falloff exponent.

§ getFieldType()

int getFieldType ( )

Field type.

§ getFluctuationDirection()

float getFluctuationDirection ( )

Fluctuation of direction in radians.

§ getFluctuationForce()

float getFluctuationForce ( )

Fluctuation of force in newton.

§ getForce()

float getForce ( )

Force in newton.

§ getInfluenceArea()

ShapeList getInfluenceArea ( )

Influence area.

§ getOrientation()

Quaternion getOrientation ( )

Orientation.

§ getPosition()

DVector getPosition ( )

Position.

§ getRadius()

float getRadius ( )

Falloff radius.

§ new()

ForceField new ( )

Create force field.

§ setApplicationType()

void setApplicationType ( int  type)

Set application type.

§ setCollisionFilter()

void setCollisionFilter ( CollisionFilter  filter)

Set collision filter.

§ setDirection()

void setDirection ( Vector  direction)

Set force direction.

§ setEnabled()

void setEnabled ( bool  enabled)

Set if force field is enabled.

§ setExponent()

void setExponent ( float  exponent)

Set falloff exponent.

§ setFieldType()

void setFieldType ( int  type)

Set field type.

§ setFluctuationDirection()

void setFluctuationDirection ( float  fluctuation)

Set fluctuation of direction in radians.

§ setFluctuationForce()

void setFluctuationForce ( float  fluctuation)

Set fluctuation of force in newton.

§ setForce()

void setForce ( float  force)

Set force in newton.

§ setInfluenceArea()

void setInfluenceArea ( ShapeList  area)

Set influence area.

§ setOrientation()

void setOrientation ( Quaternion  orientation)

Set orientation.

§ setPosition()

void setPosition ( DVector  position)

Set position.

§ setRadius()

void setRadius ( float  radius)

Set falloff radius.

Member Data Documentation

§ DIRECT

final int DIRECT = 0
static

Force application types.

Apply force equally to all elements independend of shape.

§ LINEAR

final int LINEAR = 1
static

Force is applied along the force direction.

§ MASS

final int MASS = 2
static

Apply force on mass.

§ RADIAL

final int RADIAL = 0
static

Force is applied radial from the center.

§ SPEED

final int SPEED = 3
static

Apply force relative to speed of element.

§ SURFACE

final int SURFACE = 1
static

Apply force on exposed surface area.

§ VORTEX

final int VORTEX = 2
static

Force is applied vortex like swirling around.


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