Home       Trees       Index       Help   

Blender GameEngine

Module KX_ConstraintActuator :: Class KX_ConstraintActuator
[frames | no frames]

Class KX_ConstraintActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     KX_ConstraintActuator

A constraint actuator limits the position or orientation of an object.
Method Summary
integer getDamp()
Returns the damping time of the constraint.
  getLimit()
Gets the type of constraint.
float getMax()
Gets the upper bound of the constraint.
float getMin()
Gets the lower bound of the constraint.
  setDamp(time)
Sets the time this constraint is delayed.
  setLimit(limit)
Sets the type of constraint.
  setMax(upper)
Sets the upper bound of the constraint.
  setMin(lower)
Sets the lower bound of the constraint.
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

getDamp()

Returns the damping time of the constraint.
Returns:
integer

getLimit()

Gets the type of constraint.

See module GameLogic for valid constraints.
Returns:
Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ

getMax()

Gets the upper bound of the constraint.

For rotational constraints, the upper bound is returned in radians.
Returns:
float

getMin()

Gets the lower bound of the constraint.

For rotational constraints, the lower bound is returned in radians.
Returns:
float

setDamp(time)

Sets the time this constraint is delayed.
Parameters:
time - The number of frames to delay. Negative values are ignored.
           (type=integer)

setLimit(limit)

Sets the type of constraint.

See module GameLogic for valid constraint types.
Parameters:
limit - Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ

setMax(upper)

Sets the upper bound of the constraint.

For rotational constraints, upper is specified in degrees.
Parameters:
upper
           (type=float)

setMin(lower)

Sets the lower bound of the constraint.

For rotational constraints, lower is specified in degrees.
Parameters:
lower
           (type=float)

   Home       Trees       Index       Help   

Blender GameEngine

Generated by Epydoc 2.1 on Fri Aug 27 21:08:03 2004 http://epydoc.sf.net