Search Tips

Search is based on keyword.

`Ex: "Procedures"`

Do not search with natural language

`Ex: "How do I write a new procedure?"`

Give Feedback Support Portal

# CameraScreenWindowConstraint

This node is used to orient, scale, and position the base scene graph location so that it sits at a specified distance from the camera and fits the camera screen window exactly. This is mainly useful for registering primitive plane objects with the camera for rendering through the 2D ImagePlane and MultiPlane nodes, but there are also other creative applications.

Connection Type | Connection Name | Function
Input | input | The place in the node graph where you want to constrain the base scene graph location to the camera screen window.

Control (UI) | Default Value | Function
basePath | N/A | Describes the scene graph location of the object to constrain. This should be plane geometry. 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 camera location to which the basePath object is constrained. The targetPath parameter options are available in either a 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.
distance | 1 | Sets distance from the camera at which the base scene graph location is constrained.
planeType | XY | The type of plane that is constrained: • XY • XZ
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.