RAFreeBodyRotation

class RAFreeBodyRotation

Rocky PrePost Scripting wrapper representing a Free Body Rotation motion.

Retrieve this specific wrapper after setting the correct motion type on a RAMotion. For example:

motions = motion_frame.GetMotions()
motion_1 = motions.New()
motion_1.SetType('Free Body Rotation')
free_body_rotation = motion_1.GetTypeObject()

Methods:

GetFreeMotionDirection()

Get “Free Motion Direction” as a string.

• Returns: The returned value will be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’].

GetValidFreeMotionDirectionValues()

Get a list of all possible values for “Free Motion Direction”.

• Returns: The returned list is [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’].

SetFreeMotionDirection(value: str)

Set the value of “Free Motion Direction”.

• Parameters: value – The value to set. Must be one of [‘none’, ‘x’, ‘y’, ‘xy’, ‘z’, ‘xz’, ‘yz’, ‘xyz’].
• Raises: RockyApiError – If value is not a valid “Free Motion Direction” option.