Aim Helper

Code author: Jeremy Ernst

class AimHelper(metanode)

Class that handles toggling aim mode on a component. This class is instantiated on a JointMover object. Aim mode is a mode that can be toggled that determines whether joints aim at their children when the joint mover controls are moved or rotated. This setup is done using the joint mover markup tool and setting the attributes it adds concerning aim mode.

The relevant attributes are:

• Can Aim
• Aim Joint
• Aim Axis
• Invert Aim Axis
• Up Axis
• Maintain Offset

Can Aim

Whether this joint should aim at another joint when aim mode is turned on.

Aim Joint

Which joint this joint should aim at when aim mode is turned on. (This is ignored if Can Aim is False)

Aim Axis

Which axis represents the aim axis. (This is ignored if Can Aim is False)

Invert Aim Axis

If the aim axis should be inverted. (If your aim axis is set to X, but needs to be -X, this would be True) (This is ignored if Can Aim is False)

Up Axis

The axis of the joint that is closes to the world up axis. (This is ignored if Can Aim is False)

Maintain Offset

This will probably not ever need to be used, but in the case of some special circumstance, this will create the aim constraint while maintaining offsets. (This is ignored if Can Aim is False)

setup_aim_mode()

Sets up the aim constraints on the joint mover controls that have aim mode setup.

tear_down_aim_mode()

Removes the aim constraints from the joint mover controls.

toggle_aim_mode()

Toggles aim mode on a component. Aim mode determines whether joints aim at their children when the joint mover controls are moved or rotated. Which joints and their settings are setup using the joint mover markup tool.