Texture Messages

Action Messages

• TEXTURE_LOCATOR_MATRIX_TRANSFORM - Sets the texture transform (object to unit cube) on the selected locator targets. This function takes in a matrix transforming the unit cube to world space, and computes the object to unit cube matrix for all specified model targets associated to the decal locators. This message is undoable.

  Parameters:

  • targets (tuple) - The list of locator targets whose associated models texture matrix will be set. If set to none, all selected locators will be used.

  • parameterName (unicode) - The name of the parameter representing the projection matrix to transform.

  • matrix (tuple) - An affine matrix (represented as a tuple) which transforms the unit cube to world space.

  • relative (bool) - True to multiply texture matrices of all models by the matrix, False to assign the texture matrix.

• TEXTURE_MATRIX_TRANSFORM - Sets the texture transform (object to unit cube) on the selcted targets. This function takes in a matrix transforming the unit cube to world space, and computes the object to unit cube matrix for all specified targets. This message is undoable.

  Parameters:

  • targets (tuple) - The list of targets whose texture matrix will be set. If set to none, all selected objects will be modified.

  • parameterName (unicode) - The name of the parameter representing the projection matrix to transform.

  • matrix (tuple) - An affine matrix (represented as a tuple) which transforms the unit cube to world space.

  • relative (bool) - True to multiply texture matrices of all targets by the matrix, False to assign the texture matrix.

• TEXTURE_TRANSFORM_END - Switches out of texture transform mode.

• TEXTURE_TRANSFORM_FIT - Automatically scales the texture parameter to fit the bounding box of the given objects. If no objects are specified, then the currently selected objects are used. This message is undoable.

  Parameters:

  • objectIds (tuple) - The objects to be modified.

  • projectionType (unicode) - The type of projection in effect: 'planar', 'cylinder', or 'triplanar'.

  • parameterName (unicode) - The name of the parameter to affect. (See "Class ParameterConstant" in the Showcase API Reference documentation.)

  • imageRatio (float) - The ratio of image width to height that should be fit

• TEXTURE_TRANSFORM_SET_PIVOT - Sets the texture transform pivot point to the world space coordinates provided.

  Parameters:

  • pivot (tuple) - The pivot point in world space represented as a tuple.

• TEXTURE_TRANSFORM_START - Switches into texture transform mode.

  Parameters:

  • parameterDictionary (dict) - A dictionary containing any number of parameter names to transform. (See "Class ParameterConstant" in the Showcase API Reference documentation.)

  • projectionType (unicode) - The name of the texture projection type: 'cylinder', 'planar' or 'triplanar'

Information Messages

• TEXTURE_TRANSFORM_DONE - Indicates that the texture transform mode has ended.

  Parameters:

  • parameterDictionary (dict) - A dictionary containing any number of parameter names that were affected in this mode. They are specified as: { type : name }.

• TEXTURE_TRANSFORM_DRAG_ENDED - Indicates that the user has just completed a click-drag-release cycle with the texture transform tool.

• TEXTURE_TRANSFORM_DRAG_PIVOT_DONE - Indicates that interactive pivot positioning drag has ended.

• TEXTURE_TRANSFORM_DRAG_PIVOT_STARTED - Indicates that interactive pivot positioning drag has started.

• TEXTURE_TRANSFORM_DRAG_STARTED - Indicates that the user has just started a click-drag-release cycle with the texture transform tool.

• TEXTURE_TRANSFORM_PIVOT_DONE - Indicates that the application is no longer modifying the texture transform pivot.

  Parameters:

  • parameterDictionary (dict) - A dictionary containing any number of parameter names that were affected in this mode. They are specified as: { type : name }.

• TEXTURE_TRANSFORM_PIVOT_STARTED - Indicates that the application is now modifying the texture transform pivot.

  Parameters:

  • parameterDictionary (dict) - A dictionary containing any number of parameter names that will be affected in this mode. They are specified as: { type : name }. (See "Class ParameterConstant" in the Showcase API Reference documentation.)

• TEXTURE_TRANSFORM_STARTED - Texture transform mode start response message.

  Parameters:

  • parameterDictionary (dict) - A dictionary containing any number of parameter names that will be affected in this mode. They are specified as: { type : name }.