Contact Support

BillboardConstraint

Applies an aim constraint to an object in a scene. To get the best possible aim, the constraint only rotates around the axis defined by baseRotateAxis.

Connection Type

Connection Name

Function

Input

input

The object to which you want to apply the constraint.

 

Control (UI)

Default Value

Function

basePath

N/A

Describes the scene graph location of the object to constrain. The basePath parameter options are available in either the scene graph widget or dropdown menu to the right of the parameter.

For more information, refer to the Scene Graph Location Widget Type in the Common Parameter Widgets.

targetPath

N/A

 

Describes the object(s) location to which the basePath object is constrained. The targetPath parameter options are available by clicking Add Locations or dropdown menu.

For more information, refer to the Scene Graph Location and Locations Widget Types in Common Parameter Widgets.

targetOrigin

object

Sets how the center of the target object is calculated:

object - uses the local origin of the object as the target.

boundingBox - uses the center of the object's bounding box as the target.

baseAimAxis

0.0, 0.0, -1.0

The axis of the base object that is pointed at the target.

Adjusting these values changes the axis of the object that is aimed at the target.

baseRotateAxis

0.0, 1.0, 0.0

The axis of the base object that is rotated to maintain orientation to the target.

Adjusting these values changes the rotation of the base object, while keeping the aim constant.

allowMissingTargets

No

When set to Yes, silently ignore the constraint if its target is not in the scene graph.

When set to No, produce an error on constraint resolution if the target is missing.

addToConstraintList

No

Adds base path to globals.constraintList at /root/world.

This is only needed for cases in which one constraint depends on another constraint already being evaluated. The globals.constraintList is used to specify the order of evaluation of constraints.

setRelativeTargets

No

Stores target paths in the scene graph constraint definition as paths relative to the base path.

Targets should still be specified as absolute paths in this node's parameters.