Shortcut Reference for Constraints


A complex object in Softimage might be described by hundreds or even thousands of individual parameters.

The object model provides ways to traverse through a hierarchy to visit each ProjectItem object and find its parameters. However, for convenience some of the most common parameters are promoted so that they also act as if they are parameters directly on the X3DObject parent. These are called shortcuts.

You can use shortcuts in your scripts or use the full property and parameter name syntax, although compiled code only supports the full parameter name syntax. Using shortcuts allows you to omit the names of the intermediate nodes as an alternative to specifying the full name and are available when scripting with both commands and the object model.

The following constraints have shortcuts:


Table of contents

Position


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

X

upx, pointatx, off1x, off2x

Y

upy, pointaty, off1y, off2y

Z

upz, pointatz, off1z, off2z

Coupling

coupling

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

Affected by Orientation

affbyori2

Affected by Scaling

affbyscl2


Orientation


Property name

Shortcut to use

Active

active

Offset X

offx

Offset Y

offy

Offset Z

offz


Direction


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

X

upx, pointatx, dirx, offx

Y

upy, pointaty, diry, offy

Z

upz, pointatz, dirz, offz


Pose


Property name

Shortcut to use

Active

active

W

quatw

X

posx, rotx, quatx, sclx, sclorix

Y

posy, roty, quaty, scly, scloriy

Z

posz, rotz, quatz, sclz, scloriz

Constrain Scaling

cnsscl

Constrain Orientation

cnsori

Constrain Position

cnspos

Affected by Scaling

affbyscl

Affected by Orientation

affbyori


Distance


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

X

upx, pointatx, off1x, off2x

Y

upy, pointaty, off1y, off2y

Z

upz, pointatz, off1z, off2z

Coupling

coupling

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

Affected by Orientation

affbyori2

Affected by Scaling

affbyscl2

Distance

dist


Scaling


Property name

Shortcut to use

Active

active

Offset X

offx

Offset Y

offy

Offset Z

offz


Curve path


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

Coupling

coupling

Tangency Active

tangent

X

upx, pointatx, offx, dirx

Y

upy, pointaty, offy, diry

Z

upz, pointatz, offz, dirz

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

Path Percentage

perc


Surface path


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

Coupling

coupling

Tangency Active

tangent

X

upx, pointatx, offx, dirx

Y

upy, pointaty, offy, diry

Z

upz, pointatz, offz, dirz

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

U Location

posu

V Location

posv


2 Points


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

Coupling

coupling

Tangency Active

tangent

X

upx, pointatx, offx, dirx

Y

upy, pointaty, offy, diry

Z

upz, pointatz, offz, dirz

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

Distance Percentage

perc


3 Points


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

Coupling

coupling

Tangency Active

tangent

X

upx, pointatx, offx, dirx

Y

upy, pointaty, offy, diry

Z

upz, pointatz, offz, dirz

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

U Percentage

percu

V Percentage

percv

W Percentage

percw


Object to Cluster


Property name

Shortcut to use

Active

active

Up Vector Active

upvct_active

Roll

roll

Affected by Orientation

affbyori1

Affected by Scaling

affbyscl1

Coupling

coupling

Tangency Active

tangent

X

upx, pointatx, offx, dirx, off1x

Y

upy, pointaty, offy, diry, off1y

Z

upz, pointatz, offz, dirz, off1z

Coupling

coupling


Up Vector


Property name

Shortcut to use

Up Vector

upvctcns

Up Vector Active

upvct_active

Roll

roll

Axis to Align - Up Vector

upaxis

X

upx, pointatx

Y

upy, pointaty

Z

upz, pointatz

Point At - Up Vector

pointat


Bounding Volume


Property name

Shortcut to use

Active

active

Bounding Type

type

Location

location

Threshold

threshold

Constrained Shape Type

shape

This page was last modified 18:04, 15 Dec 2010.
This page has been accessed 1677 times.

© Copyright 2009 Autodesk Inc. All Rights Reserved. Privacy Policy | Legal Notices and Trademarks | Report Piracy