vcanim.gif (8357 bytes)Model Attributes
[ Home ] [ Sales ] [ Products ] [ Services ] [ Support ] [ Downloads ]

 

 

Attributes Specific to Models

 

AttributeName Get Set Fcrvs AttributeType Description
Algorithm Y N algo SAA_AlgorithmType Specifies the type of null model (For example, standard null, skeleton effector, instance, nail, quickstretch velocity control, or bounding model).

Possible values are:

SAA_ALG_STANDARD

SAA_ALG_INV_KIN

SAA_ALG_DYNAMIC

SAA_ALG_INV_KIN_LEAF

SAA_ALG_DYNA_LEAF

SAA_ALG_GRAVITY

SAA_ALG_FORCE

SAA_ALG_WIND

SAA_ALG_DEF_GRAVITY

SAA_ALG_FAN

SAA_ALG_NAIL

SAA_ALG_DYN_MODEL

SAA_ALG_CUSTOM_ICON

SAA_ALG_INSTANCE

SAA_ALG_QS_VELOCITY

SAA_ALG_QS_ROT_VELOCITY

SAA_ALG_ENV_BOUND_BOX

SAA_ALG_ENV_BOUND_CYL

SAA_ALG_ENV_BOUND_SPHERE
BoundingBox Y N N float min_x

float min_y

float min_y

float max_x

float max_y

float max_z

 Returns the information necessary to derive the coordinates of the bounding box vertices.

SW returns this as a list: (MinX MinY MinZ MaxX MaxY MaxZ)
BranchMatte Y Y bmatte float The alpha channel value for a branch of a model hierarchy. BranchMatte is a value between 0 and 1, where 0 is transparent and 1 is opaque.

SOFTIMAGE Live uses BranchMatte   to composite a branch over a background image.

The Matte field in the Info -> Selection dialog sets both BranchMatte and NodeMatte. The Spreadsheet allows users to set the matte values separately.
BranchVisibility Y Y bvisib SAA_Boolean Indicates whether the model is part of a visible branch (TRUE) or a hidden branch (FALSE).

Setting the BranchVisiblity to FALSE for any model in a branch hides the entire branch. The NodeVisibility attribute can be used to override the BranchVisibility setting.
CenterOfMass Y N N float X

float Y

float Z

 Center of gravity calculated by SOFTIMAGE 3D.
Density Y Y N float Density of a model. Used by SOFTIMAGE 3D to calculate the mass of the model, which determines how the model reacts to physical forces.
Elasticity Y Y elast float Physical property that determines the amount of energy lost from one model when it collides with another model.
KineticFriction Y Y krough float Physical property that determines the amount of force needed to keep a moving object in motion.

(Dynamics -> Physical Properties)
Mass Y N N float Mass calculated by SOFTIMAGE 3D (density times volume).
MrAdaptiveApproximationSubdivisionLimits Y Y N long min

long max

 The maximum and minimum number of subdivisions performed by mental ray with the Spatial Adaptive and Curvature Adaptive surface approximation methods.
MrAdaptiveApproximationSubdivisionLimitsFlag Y Y N SAA_Boolean Whether to use the subdivision limits for the adaptive surface approximation methods with mental ray.
MrAdaptiveApproximationUnitsDefinition Y Y N SAA_UnitDef The units used by mental ray with the adaptive surface approximation methods:
  • SAA_UD_SYSTEM
  • SAA_UD_PIXEL
MrCurvatureApproximationAngle Y Y N float The angle between surface normals of adjacent triangles. This value is used by mental ray with the Curvature Adaptive surface approximation method.
MrCurvatureApproximationChordLength Y Y N float The distance from the tessellation to the curve. This value is used by mental ray with the Curvature Adaptive surface approximation method.
MrSpatialApproximationMaxTriangleSize Y Y N float The maximum size of the triangles generated by mental ray with the Spatial Adaptive surface approximation method. This value should be less than 1.0.
MrSurfaceApproximation Y Y N SAA_SrfApprox The type of surface approximation method used by mental ray:
  • SAA_SA_PARAM (Parametric Static)
  • SAA_SA_SPACE (Spatial Adaptive)
  • SAA_SA_CURVE (Curvature Adaptive)
NbVertices Y N N int Number of vertices in the model.
NodeMatte Y Y matte float The alpha channel value for a model node in a hierarchy. NodeMatte is a value between 0 and 1, where 0 is transparent and 1 is opaque.

SOFTIMAGE Live uses NodeMatte to composite a node over a background image.

The Matte field in the Info -> Selection dialog sets both BranchMatteand NodeMatte. The Spreadsheet allows users to set the matte values separately.
NodeVisibility Y Y nvisib SAA_Boolean Indicates whether a model is visible (TRUE) or hidden (FALSE).
PathPercentage Y N trans Not applicable Fcurve that controls the translation of a model along a path. (Path animation defines translation as a percentage of the path travelled.)

You can retrieve PathPercentage fcurves created by path animation, but you cannot create or destroy the fcurves directly. If no path animation exists, the returned fcurve is invalid.
RootAttachmentFlag Y Y rtcns SAA_Boolean Root constraint attachment flag. Corresponds to the Root Constraint Position check box in the Option Simulation Setup dialog (Dynamics -> Option Setup).
Rotation Y Y rotx

roty

rotz

 float

float

float

 Rotation of the model about the X, Y, and Z axes.getting and setting the attribute involves the use of modifiers.

SW returns this as a list: (X Y Z)
Scaling Y Y scalx

scaly

scalz

 float

float

float

 Scaling of the model along the X, Y, and Z axes.getting and setting the attribute involves the use of modifiers.

SW returns this as a list: (X Y Z)
ShapeInterpolation Y N shape Not applicable Fcurve that controls the interpolation between key shapes.

You can retrieve ShapeInterpolation fcurves created by shape animation, but you cannot create or destroy the fcurves directly. If no shape animation exists, the returned fcurve is invalid.
StaticFriction Y Y srough float Physical property that determines the amount of force needed to slide a static model onto the surface of another.

(Dynamics -> Physical Properties)
Translation Y Y etrnx

etrny

etrnz

 float

float

float

 Translation of the model along X, Y, and Z axes, getting and setting the attribute involves the use of modifiers.

SW returns this as a list: (X Y Z)
Type Y N N SAA_ModelType Specifies the type of model. Possible values are:

SAA_MNILL /* null */

SAA_MPTCH /* patch */

SAA_MFACE /* face */

SAA_MSMSH /* mesh */

SAA_MJNT /* joint */

SAA_MSPLN /* spline */

SAA_MMETA /* meta */

SAA_MBALL /* metaball */

SAA_MNCRV /* nurbs curve */

SAA_MNSRF /* nurbs surface */

When Type is SAA_MNILL (the model is a null), check the Algorithm attribute to determine the type of model.
Volume Y N N float Volume calculated from the model geometry.NOT AVAILABLE IN THIS RELEASE OF SOFTIMAGE  
The following attributes are only valid for meshes
 
mesh_NbEdges Y N N int Number of edges.
mesh_NbPolygons Y N N int Number of polygons. Used together with SAA_meshGetPolygons() to retrieve the polygons in a mesh.
mesh_NbVertices Y N N int Number of vertices.
mesh_ProcessNormals Y Y N SAA_Boolean Specifies whether normals should be averaged (TRUE) or not (FALSE). This attribute corresponds to the Process Normal check box in the Polygon Info dialog.
mesh_SurfaceArea Y N N float Surface area of the mesh.
mesh_Volume Y N N float Internal volume of the mesh.
 
 
end of attributes valid only for meshes
 
The following attributes are only valid for metaballs
 
metaball_Exponents Y Y clayex

clayey

clayez

 float x

float y

float z

 Superquadric exponents (determine the shape of the meta-clay element)
metaball_Influence Y Y N float Influence Zone
metaball_Ratio Y Y N float Core Ratio (defines the surface boundary)
metaball_Weight Y Y clywgt float Weight at the center (contributes density to the system).
 
end of attributes valid only for metaballs
 
 
The following attributes are only valid for nurbs curves
 
nurbsCurve_Closed Y Y N SAA_Boolean Specifies whether the curve is closed (TRUE) or open (FALSE).
nurbsCurve_Degree Y N N int Degree of the polynomial representing the NURBS curve. To set the degree, use SAA_nurbsCurve_EditExtended().
nurbsCurve_Parameterization Y N N SAA_NurbsParamType Knot parameterization of the NURBS curve. Possible values are:

SAA_PARAM_UNIFORM

SAA_PARAM_NON_UNIFORM

SAA_PARAM_CHORD_LENGTH

SAA_PARAM_CENTRIPETAL

NurbsCurveStep Y Y N int Number of subdivisions between control vertices. The number of steps defines the resolution of a NURBS curve.
 
end of attributes valid only for nurbs curves
 
The following attributes are only valid for nurbs surfaces
 
nurbsSurface_BottomCapping Y N N SAA_Boolean U

SAA_Boolean V

 U bottom capping.

V bottom capping.

Capping groups the points on the top or bottom row of a NURBS surface, allowing you to manipulate these points as a single point.
nurbsSurfaceClosed Y N N SAA_Boolean U

SAA_Boolean V

 Specifies whether U and V curves are closed (TRUE) or open (FALSE).
nurbsSurface_Degree Y N N int U

int V

 Degree of U curves.

Degree of V curves.

To set the degrees, use SAA_nurbsSurface_EditExtended().
nurbsSurface_NbCurves Y Y N int U

int V

 Number of U curves.

Number of V curves.
nurbsSurface_NbVertices Y N N int U

int V

 Number of U rows.

Number of V rows.
nurbsSurface_Parameterization Y N N SAA_NurbsParamType Knot parameterization of the NURBS curves. Possible values are:

SAA_PARAM_UNIFORM

SAA_PARAM_NON_UNIFORM

SAA_PARAM_CHORD_LENGTH

SAA_PARAM_CENTRIPETAL

nurbsSurface_Step Y Y N int Ustep

 

int Vstep

 Number of subdivisions between control vertices in the U and V directions.

The number of steps defines the resolution of a NURBS surface.
nurbsSurface_TopCapping Y Y N SAA_Boolean Utop

SAA_Boolean Vtop

 U top capping.

V top capping.

Capping groups the points on the top or bottom row of a NURBS surface, allowing you to manipulate these points as a single unit.
 
end of attributes valid only for nurbs surfaces
 
The following attributes are only valid for patches
 
patch_BottomCapping Y N N SAA_Boolean U

SAA_Boolean V

 U bottom capping

V bottom capping
patch_Closed Y N N SAA_Boolean U

SAA_Boolean V

 Specifies whether U and V curves are closed (TRUE) or open (FALSE).
patch_NbCurves Y Y N int U

int V

 Number of U curves.

Number of V curves.
patch_NbVertices Y N N int U

int V

 Number of vertices in the U and V directions.
patch_Step Y Y N int U

int V

 Number of subdivisions between control vertices in the U and V directions.
patch_Tension Y Y N float U

float V

 Tension applied on the control vertices of U and V curves (for Cardinal curves only).
patch_TopCapping Y N N SAA_Boolean U

SAA_Boolean V

 U top capping

V top capping
patch_Type Y N N SAA_SplineType U

SAA_SplineType V

 Types of U and V curves used to create the patch. Possible values are:

SAA_SPL_LINEAR

SAA_SPL_BEZIER

SAA_SPL_BSPLINE

SAA_SPL_CARDINAL

Modifiers for Rotation, Scaling and Translation Attributes

ModifierName Modifies Get Modifies Set Description
Object N Y If true the object is transformed, otherwise it's center is transformed.
Propagate N Y If set the transform changes are applied to all descendants of the model as well as the model itself otherwise the changes apply only to the model itself.
CoordinateSystem Y Y Specifies the coordinate system to use. Possible values are:

SAA_COORDSYS_LOCAL

SAA_COORDSYS_GLOBAL


These modifiers must appear in the order: Object, Propagate then CoordinateSystem. Here are sample calls:
SW_set context -translation $object $propagate $coordSys x y z
This gets the translation of the model in the context using the values of the passed variables to specify the center to use, whether to propagate the transform to the models descendants and the coordinate system to use. SW_set context -rotation SAA_consts(SAA_COORDSYS_GLOBAL)
This returns the rotation of the model in the passed context in GLOBAl coordinates. Note the use of the SAA_consts array to pass SAA_COORDSYS_GLOBAL

See Also

SWC_set

 

[ Behaviors Overview ] [ Behavior Evaluate ] [ Behavior Edit ] [ Debugger ] [ Console ] [ Find ] [ SAA Library ] [ SW library ] [ SWC library ] [ SWN library index ] [ SWU library ] [ Attributes Index ] [ Scripting Examples ]

copyright Video-Collage Inc.