99 lines
2.1 KiB
Python
99 lines
2.1 KiB
Python
# $Id$
|
|
# Documentation for KX_CameraActuator
|
|
from SCA_IActuator import *
|
|
|
|
class KX_CameraActuator(SCA_IActuator):
|
|
"""
|
|
Applies changes to a camera.
|
|
|
|
@ivar min: minimum distance to the target object maintained by the actuator
|
|
@type min: float
|
|
@ivar max: maximum distance to stay from the target object
|
|
@type max: float
|
|
@ivar height: height to stay above the target object
|
|
@type height: float
|
|
@ivar xy: axis this actuator is tracking, true=X, false=Y
|
|
@type xy: boolean
|
|
@ivar object: the object this actuator tracks.
|
|
@type object: KX_GameObject or None
|
|
@author: snail
|
|
"""
|
|
def getObject(name_only = 1):
|
|
"""
|
|
Returns the name of the object this actuator tracks.
|
|
|
|
@type name_only: bool
|
|
@param name_only: optional argument, when 0 return a KX_GameObject
|
|
@rtype: string, KX_GameObject or None if no object is set
|
|
"""
|
|
|
|
def setObject(target):
|
|
"""
|
|
Sets the object this actuator tracks.
|
|
|
|
@param target: the object to track.
|
|
@type target: L{KX_GameObject}, string or None
|
|
"""
|
|
|
|
def getMin():
|
|
"""
|
|
Returns the minimum distance to target maintained by the actuator.
|
|
|
|
@rtype: float
|
|
"""
|
|
|
|
def setMin(distance):
|
|
"""
|
|
Sets the minimum distance to the target object maintained by the
|
|
actuator.
|
|
|
|
@param distance: The minimum distance to maintain.
|
|
@type distance: float
|
|
"""
|
|
|
|
def getMax():
|
|
"""
|
|
Gets the maximum distance to stay from the target object.
|
|
|
|
@rtype: float
|
|
"""
|
|
|
|
def setMax(distance):
|
|
"""
|
|
Sets the maximum distance to stay from the target object.
|
|
|
|
@param distance: The maximum distance to maintain.
|
|
@type distance: float
|
|
"""
|
|
|
|
def getHeight():
|
|
"""
|
|
Returns the height to stay above the target object.
|
|
|
|
@rtype: float
|
|
"""
|
|
|
|
def setHeight(height):
|
|
"""
|
|
Sets the height to stay above the target object.
|
|
|
|
@type height: float
|
|
@param height: The height to stay above the target object.
|
|
"""
|
|
|
|
def setXY(xaxis):
|
|
"""
|
|
Sets the axis to get behind.
|
|
|
|
@param xaxis: False to track Y axis, True to track X axis.
|
|
@type xaxis: boolean
|
|
"""
|
|
|
|
def getXY():
|
|
"""
|
|
Returns the axis this actuator is tracking.
|
|
|
|
@return: True if tracking X axis, False if tracking Y axis.
|
|
@rtype: boolean
|
|
"""
|