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

Class KX_CameraActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     KX_CameraActuator


Applies changes to a camera.

Author: snail

Method Summary
float getHeight()
Returns the height to stay above the target object.
float getMax()
Gets the maximum distance to stay from the target object.
float getMin()
Returns the minimum distance to target maintained by the actuator.
  getObject()
Returns the name of the object this actuator tracks.
boolean getXY()
Returns the axis this actuator is tracking.
  setHeight(height)
Sets the height to stay above the target object.
  setMax(distance)
Sets the maximum distance to stay from the target object.
  setMin(distance)
Sets the minimum distance to the target object maintained by the actuator.
  setObject(target)
Sets the object this actuator tracks.
  setXY(xaxis)
Sets the axis to get behind.
    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

getHeight()

Returns the height to stay above the target object.
Returns:
float

getMax()

Gets the maximum distance to stay from the target object.
Returns:
float

getMin()

Returns the minimum distance to target maintained by the actuator.
Returns:
float

getObject()

Returns the name of the object this actuator tracks.

rtype: string

getXY()

Returns the axis this actuator is tracking.
Returns:
True if tracking X axis, False if tracking Y axis.
           (type=boolean)

setHeight(height)

Sets the height to stay above the target object.
Parameters:
height - The height to stay above the target object.
           (type=float)

setMax(distance)

Sets the maximum distance to stay from the target object.
Parameters:
distance - The maximum distance to maintain.
           (type=float)

setMin(distance)

Sets the minimum distance to the target object maintained by the actuator.
Parameters:
distance - The minimum distance to maintain.
           (type=float)

setObject(target)

Sets the object this actuator tracks.
Parameters:
target - the object to track.
           (type=string or KX_GameObject)

setXY(xaxis)

Sets the axis to get behind.
Parameters:
xaxis - False to track Y axis, True to track X axis.
           (type=boolean)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net