Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Functions
cmds Namespace Reference

This module defines python Clarisse commands. More...

Functions

def CreateCAMAttribute
 Create specified CAM attributes.
 
def CreateCAMAttribute
 Create specified CAM attributes.
 
def RemoveCAMAttribute
 Remove specified CAM attributes.
 
def RemoveAllCAMAttributes
 Remove specified CAM attributes.
 
def EditCAMAttribute
 Edit specified CAM attributes.
 
def EditCAMAttribute
 Edit specified CAM attributes.
 
def EditCAMRule
 Edit specified CAM rule.
 
def EditCAMRule
 Edit specified CAM rule.
 
def DisableCAM
 Disable CAM override.
 
def SetCurve
 Set curve for specified attributes (replace any existing curve).
 
def AddCurveValue
 Add keys to already existing curves for given attributes.
 
def RemoveCurveValue
 Remove keys for given attributes.
 
def SetCurveKeyValue
 Set keys values for specified attributes.
 
def SetCurveKeyPosition
 Set keys positions for specified attributes.
 
def SetCurveKeyType
 Set keys types for specified attributes.
 
def SetKey
 Add an animation key in one or more attributes.
 
def RemoveKey
 Removes animation keys from given attrs with specified ids.
 
def RemoveKeysAt
 Removes animation keys from given attrs at specified time.
 
def InsertKeysAt
 Insert animation keys from given attrs at specified time.
 
def RemoveFCurve
 Remove animation for given attributes.
 
def BakeFCurve
 Set an animation key on each frame for given attributes.
 
def SetKeysPropertyValues
 Sets keyframe property value.
 
def SetKeyTangents
 Sets keyframe tangents values.
 
def SetCurveExtrapolationMode
 Set curve extrapolation mode for specified attributes.
 
def GoToPreviousKeyframe
 Change time to the time of previous keyframe within the current selection keyframes.
 
def GoToNextKeyframe
 Change time to the time of next keyframe within the current selection keyframes.
 
def SetExpression
 Set the expression for specified attribute values.
 
def ActivateExpression
 Enable consideration of the expression for specified attribute values.
 
def ClearTable
 Clear the whole table values.
 
def LocalizeTable
 (un)Localize the whole table.
 
def LockTable
 Lock or unlock the whole table.
 
def HideTable
 Hide or show the whole table.
 
def RevertTable
 Revert the whole table.
 
def ResetTable
 Reset the whole table.
 
def AddTableRow
 Append a new row at the end of an attribute table.
 
def AddTableRow
 Insert a new row in an attribute table.
 
def RemoveTableRow
 Remove the last row of an attribute table.
 
def RemoveTableRow
 Remove a specific row of an attribute table.
 
def RemoveTableRows
 Remove multiple rows from a table.
 
def SwapTableRows
 Swap 2 rows of an attribute table.
 
def MoveTableRow
 Move a row to another index, while preserving the relative order of the other rows.
 
def SetTableRow
 Set an attribute table's row values.
 
def SetTableCell
 Set an attribute table's cell values.
 
def SetTableCell
 Set an attribute table's cell value.
 
def EnableTableRow
 Enable or disable a specific row of an attribute table.
 
def EnableTableRows
 Enable or disable multiple rows from a table.
 
def AddShadingLayerRule
 Adds a rule to a shading layer.
 
def RemoveShadingLayerRules
 Removes rules from a shading layer.
 
def SetShadingLayerRulesProperty
 Set values for a property of shading layer rules.
 
def MoveShadingLayerRules
 Move rules positions in a shading layer.
 
def MoveShadingLayerRules
 Move rules positions in a shading layer.
 
def CreateShadingLayerForItems
 Create shading layer and create rules from existing items.
 
def Isolate
 Set isolation content (replace any existing content).
 
def IsolateAdd
 Add items to isolation content.
 
def IsolateRemove
 Remove items from isolation content.
 
def IsolateSwap
 Reverses isolation content.
 
def LockItems
 Lock items.
 
def LockItem
 Lock item.
 
def UnlockItems
 Unlock items.
 
def UnlockItem
 Unlock item.
 
def DisableItems
 Disable items.
 
def ColorTagItems
 Set a color tag on items.
 
def CommentItem
 Set a comment on item.
 
def CommentItems
 Set a comment on items.
 
def CopyItemTo
 Copy item to a specified location.
 
def MoveItemTo
 Move item to a specified location.
 
def CreateInstanceTo
 Create instance of an item to a specified location.
 
def CreateInstancesTo
 Create instance of items to a specified location.
 
def CopyItemsTo
 Copy items to a specified location.
 
def MoveItemsTo
 Move items to a specified location.
 
def GroupItems
 Create a group with all specified items in it.
 
def CombineItems
 Create a combiner with all specified items in it.
 
def CombineItems
 Create a combiner with all specified items in it.
 
def ClearParticle
 Empties specified Particle cloud(s).
 
def JitterParticle
 Jitter specified Particle cloud(s).
 
def BakeParticle
 Create a GeometryParticle baking the point clouds of all specified geometries.
 
def ActivatePackageEditLayer
 Set active edit layer for a build package.
 
def AddPackageEditLayer
 Add a new empty edit layer in a build package.
 
def RemovePackageEditLayers
 Remove the given edit layers from a build package.
 
def DisablePackageLayer
 Disable the given layers in a build package.
 
def LockPackageLayers
 Lock/unlock the given layers in a build package.
 
def ClearPackageEditLayers
 Clear all edits of the given edit layers in a build package.
 
def RenamePackageLayer
 Rename the given layer in a build package.
 
def DuplicatePackageEditLayer
 Duplicate an edit layer in a build package.
 
def MovePackageLayer
 Move a layer in a build package.
 
def PermutePackageLayers
 Reorder all layers in a build package.
 
def MergePackageEditLayers
 Merge a list of edit layers into the first one.
 
def CommentPackageLayers
 Comment the given layers in a build package.
 
def AddPackagePreset
 Add a new preset corresponding to the current layers visibilities.
 
def RemovePackagePreset
 Remove a preset from a build package.
 
def RemoveAllPresets
 
def DuplicatePackagePreset
 Duplicate a preset in a build package.
 
def RenamePackagePreset
 Rename a preset in a build package.
 
def PublishPackagePreset
 Specify if a preset must be displayed in the attribute editor of a build package.
 
def CommentPackagePreset
 Change the description of a preset in a build package.
 
def GroupPackageLayers
 Add a new group of layers in a build package.
 
def UngroupPackageLayers
 Remove group layers from a build package.
 
def CreateObject
 Creates a new object in factory.
 
def CreateObject
 Creates a new object in factory.
 
def Instantiate
 Instantiate items.
 
def DeleteSelection
 Deletes current application selected items.
 
def DeleteItem
 Deletes item.
 
def DeleteItems
 Deletes items.
 
def TrashItems
 Not undoable delete items command.
 
def ResetAttributes
 Reset the attributes to its default value.
 
def RevertAttributes
 Revert attribute to its initial(deserialized) value.
 
def RevertItemsOverrides
 Revert overrides on specified items.
 
def RevertSubItemsOverrides
 Revert overrides on sub-items of specified items.
 
def ActivateShadingVariable
 Activate shading variable to multiple attributes.
 
def BindToShadingVariable
 Binds a shading variable to multiple attributes.
 
def UnbindShadingVariable
 Unbinds multiple attributes from a shading variable.
 
def SetValue
 Sets the values of an attribute.
 
def SetValues
 Sets the values for multiple attributes.
 
def AddValues
 Adds values to multiple attributes.
 
def AddValue
 Adds value to an attribute.
 
def AddToGroup
 Adds items to groups.
 
def MoveValue
 Move a value from an attribute value index to another.
 
def PermuteValues
 Permute values in specified attribute.
 
def RemoveValue
 Removes values from attributes.
 
def RemoveAllValues
 Removes all values from specified attributes.
 
def SetValueCount
 Sets the number of values of specified attributes.
 
def RenameItem
 Rename an item.
 
def SetTexture
 Set a texture for specified attributes.
 
def SetOutputBinding
 Connect an output plug to specified attributes.
 
def SetChannel
 Set channel for specified attribute.
 
def SetFps
 Set application Fps.
 
def SetParentInPlace
 Set application parent in place.
 
def SetCurrentTime
 Set application current time.
 
def SetCurrentFrame
 Set application current frame.
 
def SetCurrentFrameRange
 Set application current frame range.
 
def SetCurrentFrameRangeMin
 Set application current frame range min.
 
def SetCurrentFrameRangeMax
 Set application current frame range max.
 
def SetItemViewPoint
 Set item view point.
 
def CreateContext
 Create a new context in application current context.
 
def CreateContext
 Create a new context at a specified location.
 
def CreateCustomContext
 Create a new context at a specified location with a specified context engine.
 
def CreateCustomContext
 Create a new context at a specified location with a specified context engine.
 
def PaintInstance
 Creates an object instance with specified translate-rotate-scale.
 
def PaintCopy
 Creates an object instance with specified translate-rotate-scale.
 
def SetItemsPositions
 Sets items position in nodal.
 
def SetItemPosition
 Sets item position in nodal.
 
def SetItemsNodalProperties
 Sets items properties in nodal.
 
def SetItemsNodalProperties
 Sets items properties in nodal.
 
def SetItemNodalProperty
 Sets item property in nodal.
 
def SetItemNodalProperty
 Sets item property in nodal.
 
def CreateFileReference
 Create new file reference contexts in the specified context.
 
def SetReferenceFilename
 Sets the filename that will be referenced by the specified contexts.
 
def SetReferenceFilenames
 Sets the filenames that will be referenced by the specified contexts.
 
def RemoveReferenceFilename
 Remove filenames referenced by the specified contexts.
 
def AddReferenceFilename
 Adds filenames that will be referenced by the specified contexts.
 
def PermuteReferenceFilename
 Permute filename values in the specified contexts.
 
def ClearContextOverrides
 Clear all overrides from a referenced context.
 
def CleanupContextOverrides
 Clean all stored overrides from a referenced context.
 
def CreateOverrideSet
 Create an override set from overrides on a referenced context.
 
def ExportContextAsReference
 Exports the specified context as a standalone project and makes it a reference in the current project.Note that exporting a reference context will export the overrides if any.
 
def ConvertToUsdReference
 Convert classic file reference contexts (OfFileReferenceContextEngine) referencing USD filesinto contexts using the dedicated UsdReferenceContextEngine and referencing the same files.
 
def LocalizeAttributes
 Localize or unlocalize specified attributes.
 
def MuteLocalValueAttributes
 Mute or un-mute local value consideration for specified attributes.
 
def DisableAttributes
 Disable or enable existency of specified attributes.
 
def DisableAttributeValue
 Disable or enable specified index of attribute values.
 
def LockAttributes
 Lock or unlock specified attributes.
 
def LockAttributeValues
 
def CreateCustomAttribute
 Create specified custom attributes.
 
def CreateCustomAttribute
 Create specified custom attributes.
 
def EditCustomAttribute
 Edit specified custom attributes.
 
def EditCustomAttribute
 Edit specified custom attributes.
 
def RemoveCustomAttribute
 Remove specified custom attributes.
 
def MakeLocalContext
 Make local a referenced context.
 
def MakeLocalContexts
 Make local a referenced context.
 
def MakeLocal
 Localize any instantiated item.
 
def MakeLocal
 Localize any instantiated item.
 
def MakeInstance
 Instantiate any item.
 
def CenterObjectsPivots
 Center objects pivots to bounding box center.
 
def CenterObjectsPivots
 Center objects pivots to bounding box center or ground.
 
def ResetObjectsPivots
 Reset objects pivots.
 
def ResetObjectsPivots
 Reset objects pivots.
 
def RemoveObjectsOffsets
 Remove objects offsets.
 
def RecordObjectsOffsets
 Record objects transformations as offsets.
 
def SetObjectsTranslation
 
def SetObjectsRotation
 
def SetObjectsScaling
 
def SetObjectsLocalTransform
 Set objects local transformation matrix.
 
def SetObjectsGlobalTransform
 Set objects global transformation matrix.
 
def ResetObjectsTransform
 Reset objects transformation matrix.
 
def ImportProject
 Import specified project(s) in current context.
 
def ImportProject
 Import specified project(s) in current context.
 
def MergeProject
 Merge specified project(s) in current context.
 
def SetParent
 Set the parent kinematic object.
 
def AddParticle
 Add particles to the specified Particle cloud.
 
def AddParticle
 Add particles to the specified Particle cloud.
 
def RemoveParticle
 Remove particles from specified Particle cloud, decimating the particles whom ids are provided.
 
def MoveParticle
 Move particles from specified Particle cloud, applying to the particles whom ids are provided a given amount of translation, expressed either in world, object or local space.
 
def MoveParticle
 Move particles from specified Particle cloud, setting the particles whom ids are provided to specified locations.
 
def EditParticlesProperty
 Change properties of specified Particle cloud, modifying specified property for the particles whom ids are provided, according to given mode and value.
 
def CreateParticlesProperty
 Add property to specified Particle cloud, according to given type, dimension and value.
 
def DeleteParticlesProperties
 Remove properties from a given Particle cloud.
 
def RenameParticlesProperty
 Rename a given property for the specified Particle cloud(s).
 
def SetAutofitMode
 Enable/disable backdrop autofitting.
 
def SetUsdBundleFilename
 Set filename values on the specified USD bundles.
 
def RemoveUsdBundleFilename
 Remove filename values on the specified USD bundles.
 
def AddLayer
 Add a new layer for an image.
 
def DeleteLayer
 Delete one or more layers from an image.
 
def DuplicateLayer
 Duplicate layers in an image.
 

Detailed Description

This module defines python Clarisse commands.

The file is automatically imported directly inside the ix module. To access the functions just type for example: ix.cmds.my_command('my_param')

Function Documentation

def cmds.ActivateExpression (   attr_fullnames,
  enable_states 
)

Enable consideration of the expression for specified attribute values.

Disabling consideration will not lose stored expression associated to the attribute value.

Parameters
attr_fullnamestype string[] - attribute full names, each attribute can specify value index using indexation operator at the end of the attribute name (eg. [0] to specify the first value only), otherwise all the values of the attribute will be setted.
enable_statestype bool[] -
def cmds.ActivatePackageEditLayer (   build_package_path,
  layer_index 
)

Set active edit layer for a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indextype int - Index of the edit layer to activate, -1 to reset.
def cmds.ActivateShadingVariable (   attr_paths,
  values 
)

Activate shading variable to multiple attributes.

Parameters
attr_pathstype string[] - Attribute to set value to.
valuestype bool[] - values to set.
def cmds.AddCurveValue (   attr_pathes,
  serial 
)

Add keys to already existing curves for given attributes.

Parameters
attr_pathestype string[] - Curve or Gradient attributes.
serialtype float[] - Serialized keys. Format: for each channel [key_count, k1_type, k1_x, k1_y,..., kn_type, kn_x, kn_y]
def cmds.AddLayer (   attr_path,
  class_name 
)

Add a new layer for an image.

Parameters
attr_pathtype string - image layers attribute path. ex: project://scene/image1.layers
class_nametype string - Class name of layer to add
def cmds.AddPackageEditLayer (   build_package_path,
  layer_name,
  layer_index,
  group_index 
)

Add a new empty edit layer in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_nametype string - Layer name
layer_indextype int - Index to insert at (-1 to add on top of stack).
group_indextype int - Index of parent group (-1 to set no parent).
def cmds.AddPackagePreset (   build_package_path,
  name,
  is_published,
  description 
)

Add a new preset corresponding to the current layers visibilities.

Parameters
build_package_pathtype string - Full path to a build package.
nametype string - Name of the preset.
is_publishedtype bool - Does this preset must be displayed in the build package preset attribute?
descriptiontype string - Description of this preset.
def cmds.AddParticle (   item,
  positions 
)

Add particles to the specified Particle cloud.

Parameters
itemtype string - GeometryParticle to add to
positionstype vec3d[] - locations of particles to add
def cmds.AddParticle (   item,
  positions,
  normals 
)

Add particles to the specified Particle cloud.

Parameters
itemtype string - GeometryParticle to add to
positionstype vec3d[] - locations of particles to add
normalstype vec3d[] - normals of particles to add
def cmds.AddReferenceFilename (   contexts,
  filenames 
)

Adds filenames that will be referenced by the specified contexts.

Parameters
contextstype context[] - Contexts that reference external file.
filenamestype string[] - Full name of the external files.
def cmds.AddShadingLayerRule (   shading_layer,
  index,
  sl_params 
)

Adds a rule to a shading layer.

Parameters
shading_layertype string - Related shading layer.
indextype int - index where to add the new rule.
sl_paramstype string[] - New rule couples of parameter/value:
'filter' to define rule filter.
'is_visible' to define rule visibility ('0' or '1')
'material' to define rule material (requires an object full name).
def cmds.AddTableRow (   table_path)

Append a new row at the end of an attribute table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
def cmds.AddTableRow (   table_path,
  row_index 
)

Insert a new row in an attribute table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - Index where we should insert the new row.
def cmds.AddToGroup (   groups,
  items 
)

Adds items to groups.

Parameters
groupstype string[] - Groups to add items to.
itemstype string[] - items to be added.
def cmds.AddValue (   attr,
  value 
)

Adds value to an attribute.

Parameters
attrtype string - Attribute to add value to.
valuetype string - value to be added.
def cmds.AddValues (   attrs,
  values 
)

Adds values to multiple attributes.

Parameters
attrstype string[] - Attributes to add value to.
valuestype string[] - values to be added.
def cmds.BakeFCurve (   attr_paths,
  step 
)

Set an animation key on each frame for given attributes.

Parameters
attr_pathstype string[] - related attributes
steptype float - frame step
def cmds.BakeParticle (   items,
  location 
)

Create a GeometryParticle baking the point clouds of all specified geometries.

Parameters
itemstype string[] - geometries to bake
locationtype string - where to create the object: a context name
def cmds.BindToShadingVariable (   attr_paths,
  values 
)

Binds a shading variable to multiple attributes.

Parameters
attr_pathstype string[] - Attribute to set value to.
valuestype string[] - values to set.
def cmds.CenterObjectsPivots (   objects)

Center objects pivots to bounding box center.

Parameters
objectstype string[] - objects which pivot will be centered
def cmds.CenterObjectsPivots (   objects,
  rest_on_ground 
)

Center objects pivots to bounding box center or ground.

Parameters
objectstype string[] - objects which pivot will be centered
rest_on_groundtype bool - locate on Bbox ground if true, on Bbox center otherwise (meaningful only for geometries).
def cmds.CleanupContextOverrides (   context)

Clean all stored overrides from a referenced context.

Parameters
contexttype context - context from which overrides will be removed.
def cmds.ClearContextOverrides (   context)

Clear all overrides from a referenced context.

Parameters
contexttype context - context from which all overrides will be removed.
def cmds.ClearPackageEditLayers (   build_package_path,
  layer_indices 
)

Clear all edits of the given edit layers in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - List of indices of edit layers in the build package to clear.
def cmds.ClearParticle (   items)

Empties specified Particle cloud(s).

Parameters
itemstype string[] - GeometryParticle objects to clear
def cmds.ClearTable (   table_path)

Clear the whole table values.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
def cmds.ColorTagItems (   items,
  tag 
)

Set a color tag on items.

Parameters
itemstype string[] - names of items to tag
tagtype string - value to assign, as defined in Color Tag configuration file (empty string to clear)
def cmds.CombineItems (   items,
  location 
)

Create a combiner with all specified items in it.

Parameters
itemstype string[] - items to combine together
locationtype string - where to create the combiner: at least a context name, eventually a target object name (the combiner will be located before the target)
def cmds.CombineItems (   items,
  location,
  pivot_location 
)

Create a combiner with all specified items in it.

Parameters
itemstype string[] - items to combine together
locationtype string - where to create the combiner: at least a context name, eventually a target object name (the combiner will be located before the target)
pivot_locationtype int - For the new combiner. Among Bbox center, Bbox ground, Origin, Center (average pivot locations of all specified items), Master (pivot of first selected item). Default is bounding box center.
def cmds.CommentItem (   item,
  comment 
)

Set a comment on item.

Parameters
itemtype string - item to comment
commenttype string - value to assign (empty string to clear)
def cmds.CommentItems (   items,
  comment 
)

Set a comment on items.

Parameters
itemstype string[] - names of items to comment
commenttype string - value to assign (empty string to clear)
def cmds.CommentPackageLayers (   build_package_path,
  layer_indices,
  comment 
)

Comment the given layers in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - List of layers indices to comment.
commenttype string - Comment to set on the layers.
def cmds.CommentPackagePreset (   build_package_path,
  name,
  description 
)

Change the description of a preset in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
nametype string - Name of the preset.
descriptiontype string - The description of this preset.
def cmds.ConvertToUsdReference (   context_paths)

Convert classic file reference contexts (OfFileReferenceContextEngine) referencing USD filesinto contexts using the dedicated UsdReferenceContextEngine and referencing the same files.

Parameters
context_pathstype string[] - List of full paths of file reference contexts to convert.
def cmds.CopyItemsTo (   items,
  location 
)

Copy items to a specified location.

Parameters
itemstype string[] - items to be copied
locationtype string - where to copy the items: at least a context name, eventually a target object name (new items will be located before the target).if no location is specified, each copy is added inside the same context of the item.
def cmds.CopyItemTo (   item,
  location 
)

Copy item to a specified location.

Parameters
itemtype string - item to be copied
locationtype string - where to copy the item: at least a context name, eventually a target object name (new item will be located before the target)if no location is specified, the copy is added inside the same context of the item.
def cmds.CreateCAMAttribute (   context_paths,
  attr_name,
  attr_type,
  additionnal_params,
  additionnal_params_values,
  cam_rule,
  cam_exclusion_rule 
)

Create specified CAM attributes.

Parameters
context_pathstype string[] - contexts to create attribute in
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
additionnal_paramstype string[] - allows to specify keywords for additionnal parameter to set on the attribute to create
additionnal_params_valuestype string[] - allows to specify values for additionnal parameter to set on the attribute to create
cam_ruletype string - rule to filter out objects to select attributes to override
cam_exclusion_ruletype string - rule to filter out objects to exclude attributes to override
def cmds.CreateCAMAttribute (   context_paths,
  attr_name,
  attr_type,
  attr_container,
  attr_visual_hint,
  group_name,
  cam_rule,
  cam_exclusion_rule 
)

Create specified CAM attributes.

Parameters
context_pathstype string[] - contexts to create attribute in
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
attr_containertype int - container type of the attribute to create
attr_visual_hinttype int - visual hint of the attribute to create
group_nametype string - name of the group of the attribute to create
cam_ruletype string - rule to filter out objects to select attributes to override
cam_exclusion_ruletype string - rule to filter out objects to exclude attributes to override
def cmds.CreateContext (   context_name)

Create a new context in application current context.

Parameters
context_nametype string - new context name
def cmds.CreateContext (   context_name,
  context_path 
)

Create a new context at a specified location.

Parameters
context_nametype string - new context name
context_pathtype string - new context location
def cmds.CreateCustomAttribute (   item_paths,
  attr_name,
  attr_type,
  additionnal_params,
  additionnal_params_values 
)

Create specified custom attributes.

Parameters
item_pathstype string[] - item to create attribute in
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
additionnal_paramstype string[] - allows to specify keywords for additionnal parameter to set on the attribute to create ('container', 'vhint', 'group', 'count', 'num_min', 'num_max', 'ui_min', 'ui_max', 'texturable', 'animatable', 'shading_var', 'allow_expression')
additionnal_params_valuestype string[] - allows to specify values for additionnal parameter to set on the attribute to create
def cmds.CreateCustomAttribute (   item_paths,
  attr_name,
  attr_type,
  attr_container,
  attr_visual_hint,
  group_name 
)

Create specified custom attributes.

Parameters
item_pathstype string[] - item to create attribute in
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
attr_containertype int - container type of the attribute to create
attr_visual_hinttype int - visual hint of the attribute to create
group_nametype string - name of the group of the attribute to create
def cmds.CreateCustomContext (   context_name,
  context_engine,
  context_path 
)

Create a new context at a specified location with a specified context engine.

Parameters
context_nametype string - new context name
context_enginetype string - new context engine
context_pathtype string - new context location
def cmds.CreateCustomContext (   context_name,
  context_engine,
  selection_slot,
  context_path 
)

Create a new context at a specified location with a specified context engine.

Parameters
context_nametype string - new context name
context_enginetype string - new context engine
selection_slottype string - selection slot
context_pathtype string - new context location
def cmds.CreateFileReference (   context,
  filenames 
)

Create new file reference contexts in the specified context.

Parameters
contexttype string - Context where the reference contexts will be located.
filenamestype string[] - For each filename, a reference context will be created.
def cmds.CreateInstancesTo (   items,
  location 
)

Create instance of items to a specified location.

Parameters
itemstype string[] - items to instantiate
locationtype string - where to create the instances: at least a context name, eventually a target object name (new items will be located before the target)
def cmds.CreateInstanceTo (   item,
  location 
)

Create instance of an item to a specified location.

Parameters
itemtype string - item to instantiate
locationtype string - where to create the instance: at least a context name, eventually a target object name (new item will be located before the target)
def cmds.CreateObject (   object_name,
  class_name 
)

Creates a new object in factory.

Parameters
object_nametype string - Name of the new object.
class_nametype string - Class of the new object
def cmds.CreateObject (   object_name,
  class_name,
  context_path 
)

Creates a new object in factory.

Parameters
object_nametype string - Name of the new object.
class_nametype string - Class of the new object
context_pathtype string - context where to create the new object. Current application selection by default.
def cmds.CreateOverrideSet (   context)

Create an override set from overrides on a referenced context.

Parameters
contexttype context - context from which override set will be created from.
def cmds.CreateParticlesProperty (   item,
  name,
  type,
  dim,
  value 
)

Add property to specified Particle cloud, according to given type, dimension and value.

Parameters
itemtype string - GeometryParticle to modify
nametype string - property to create
typetype int - type of value (int, float...) as defined in ResourceProperty
dimtype int - number of subvalues (for ex. 1 for a weight, 3 for a color)
valuetype string - stringified value used to initialize
def cmds.CreateShadingLayerForItems (   items,
  creation_mode,
  context_path 
)

Create shading layer and create rules from existing items.

Parameters
itemstype string[] - items to create rules for
creation_modetype int - 1 Use Full Names. 2 Use Relative Names. 3 Use Kinematics. 4 Use Shading Groups names
context_pathtype string - If mode is 2 (Relative Names) this argument specify to which context it applies.
def cmds.DeleteItem (   item)

Deletes item.

Parameters
itemtype string - Item to delete.
def cmds.DeleteItems (   items)

Deletes items.

Parameters
itemstype string[] - Items to delete.
def cmds.DeleteLayer (   image,
  indices 
)

Delete one or more layers from an image.

Parameters
imagetype string -
indicestype int[] - indexes of layers to delete
def cmds.DeleteParticlesProperties (   item,
  names 
)

Remove properties from a given Particle cloud.

Parameters
itemtype string - GeometryParticle object to modify
namestype string[] - properties to remove
def cmds.DeleteSelection ( )

Deletes current application selected items.

def cmds.DisableAttributes (   attr_paths,
  disable 
)

Disable or enable existency of specified attributes.

Parameters
attr_pathstype string[] - attributes to disable/enable
disabletype bool - Specify to disable (true) or enable (false).
def cmds.DisableAttributeValue (   attr_paths,
  value_indices,
  disable 
)

Disable or enable specified index of attribute values.

Parameters
attr_pathstype string[] - attributes to consider
value_indicestype int[] - index of the values to disable/enable per attribute
disabletype bool - Specify to disable (true) or enable (false).
def cmds.DisableCAM (   attribute_paths,
  disabled 
)

Disable CAM override.

Parameters
attribute_pathstype string[] -
disabledtype bool - disabled state of the CAM
def cmds.DisableItems (   items,
  disable 
)

Disable items.

Parameters
itemstype string[] - items to disable
disabletype bool - specifies to disable or enable concerned items
def cmds.DisablePackageLayer (   build_package_path,
  layer_indices,
  value 
)

Disable the given layers in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - List of indices of layers to disable/enable.
valuetype bool - If true, the layers are disabled, otherwise they are enabled.
def cmds.DuplicateLayer (   attr_path,
  selected_layers 
)

Duplicate layers in an image.

Parameters
attr_pathtype string - image layers attribute path. ex: project://scene/image1.layers
selected_layerstype int[] - indexes of layers to duplicate
def cmds.DuplicatePackageEditLayer (   build_package_path,
  layer_index,
  new_layer_index 
)

Duplicate an edit layer in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indextype int - Index of the edit layer to duplicate.
new_layer_indextype int - Index of the created edit layer.
def cmds.DuplicatePackagePreset (   build_package_path,
  name 
)

Duplicate a preset in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
nametype string - Name of the preset.
def cmds.EditCAMAttribute (   attr_paths,
  attr_name,
  attr_type,
  attr_container,
  attr_visual_hint,
  group_name,
  cam_rule 
)

Edit specified CAM attributes.

Parameters
context_pathstype string[] - contexts to create attribute in
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
additionnal_paramstype string[] - allows to specify keywords for additionnal parameter to set on the attribute to create
additionnal_params_valuestype string[] - allows to specify values for additionnal parameter to set on the attribute to create
cam_ruletype string - rule to filter out objects to select attributes to override
cam_exclusion_ruletype string - rule to filter out objects to exclude attributes to override
attr_pathstype string[] - CAM attributes to edit
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
attr_containertype int - container type of the attribute to create
attr_visual_hinttype int - visual hint of the attribute to create
group_nametype string - name of the group of the attribute to create
cam_ruletype string - rule to filter out objects to select attributes to override
def cmds.EditCAMAttribute (   attr_paths,
  attr_name,
  attr_type,
  attr_container,
  attr_visual_hint,
  group_name,
  cam_rule,
  cam_exclusion_rule 
)

Edit specified CAM attributes.

Parameters
attr_pathstype string[] - CAM attributes to edit
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
attr_containertype int - container type of the attribute to create
attr_visual_hinttype int - visual hint of the attribute to create
group_nametype string - name of the group of the attribute to create
cam_ruletype string - rule to filter out objects to select attributes to override
cam_exclusion_ruletype string - rule to filter out objects to exclude attributes to override
def cmds.EditCAMRule (   attribute_paths,
  cam_rule 
)

Edit specified CAM rule.

Parameters
attribute_pathstype string[] -
cam_ruletype string - the new rule to filter out objects to select attributes to override
def cmds.EditCAMRule (   attribute_paths,
  cam_rule,
  cam_exclusion_rule 
)

Edit specified CAM rule.

Parameters
attribute_pathstype string[] -
cam_ruletype string - the new rule to filter out objects to select attributes to override
cam_exclusion_ruletype string - the new rule to filter out objects to exclude attributes to override
def cmds.EditCustomAttribute (   item_paths,
  attr_name,
  attr_type,
  additionnal_params,
  additionnal_params_values 
)

Edit specified custom attributes.

Parameters
item_pathstype string[] -
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
additionnal_paramstype string[] - allows to specify keywords for additionnal parameter to set on the attribute to create
additionnal_params_valuestype string[] - allows to specify values for additionnal parameter to set on the attribute to create
def cmds.EditCustomAttribute (   attr_paths,
  attr_name,
  attr_type,
  attr_container,
  attr_visual_hint,
  group_name 
)

Edit specified custom attributes.

Parameters
attr_pathstype string[] - attributes to edit
attr_nametype string - name of the attribute to create
attr_typetype int - type of the attribute to create
attr_containertype int - container type of the attribute to create
attr_visual_hinttype int - visual hint of the attribute to create
group_nametype string - name of the group of the attribute to create
def cmds.EditParticlesProperty (   item,
  name,
  ids,
  mode,
  value 
)

Change properties of specified Particle cloud, modifying specified property for the particles whom ids are provided, according to given mode and value.

Parameters
itemtype string - GeometryParticle to modify
nametype string - property to modify
idstype int[] - ids of particles to modify
modetype int - action to perform (set, add, multiply, clear)
valuetype string - stringified value used to edit
def cmds.EnableTableRow (   table_path,
  row_index,
  enabled 
)

Enable or disable a specific row of an attribute table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - The index of the row to remove.
enabledtype bool - Enabled state for the row.
def cmds.EnableTableRows (   table_path,
  row_indices,
  enabled 
)

Enable or disable multiple rows from a table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indicestype int[] - The indices of the rows to remove.
enabledtype bool[] - For each row index, its enabled state.
def cmds.ExportContextAsReference (   context,
  filename 
)

Exports the specified context as a standalone project and makes it a reference in the current project.Note that exporting a reference context will export the overrides if any.

Parameters
contexttype context - Context to export.
filenametype string - Filename of project in which the context is exported.
def cmds.GroupItems (   items,
  location 
)

Create a group with all specified items in it.

Parameters
itemstype string[] - items to group together
locationtype string - where to create the group: at least a context name, eventually a target object name (the group will be located before the target)
def cmds.GroupPackageLayers (   build_package_path,
  group_name,
  layer_index,
  layer_count,
  parent_group_index 
)

Add a new group of layers in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
group_nametype string - Group name
layer_indextype int - Index where to start the group (-1 to add on top of stack).
layer_counttype int - Number of layers (0 to add an empty group).
parent_group_indextype int - Index of parent group, used only if layer_count is null to specify the location of the new group in hierarchy.
def cmds.HideTable (   table_path,
  hidden 
)

Hide or show the whole table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
hiddentype bool - If true the table is hidden, otherwise it's shown.
def cmds.ImportProject (   filenames)

Import specified project(s) in current context.

Parameters
filenamestype string[] - for each filename a new context will be created.
def cmds.ImportProject (   filenames,
  import_as_root_project 
)

Import specified project(s) in current context.

Parameters
filenamestype string[] - for each filename a new context will be created.
import_as_root_projecttype bool - specify if the context in which each project is imported is "build://project" and must be set as vizroot before loading each project.
def cmds.InsertKeysAt (   attr_pathes,
  time 
)

Insert animation keys from given attrs at specified time.

Parameters
attr_pathestype string[] - related attributes
timetype float - all keys at this time will be inserted
def cmds.Instantiate (   items)

Instantiate items.

Parameters
itemstype string[] - Items to instantiate.
def cmds.Isolate (   items)

Set isolation content (replace any existing content).

Parameters
itemstype string[] - items to show
def cmds.IsolateAdd (   items)

Add items to isolation content.

Parameters
itemstype string[] - items to show
def cmds.IsolateRemove (   items)

Remove items from isolation content.

Parameters
itemstype string[] - items to hide
def cmds.IsolateSwap ( )

Reverses isolation content.

def cmds.JitterParticle (   items,
  variance,
  space,
  signed 
)

Jitter specified Particle cloud(s).

Parameters
itemstype string[] - GeometryParticle objects to jitter
variancetype vec3d - max amount of translation along each axis in specified space
spacetype int - 0=world, 1=object, 2=local (y=particle normal, z=particle velocity
signedtype bool - if false, randomize variance in [-0.5, +0.5] range, if true, randomize variance in [0,1] range
def cmds.LocalizeAttributes (   attr_paths,
  localize 
)

Localize or unlocalize specified attributes.

Parameters
attr_pathstype string[] - attributes to localize or unlocalize
localizetype bool - Specify to localize (true) or unlocalize (false).
def cmds.LocalizeTable (   table_path,
  localize 
)

(un)Localize the whole table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
localizetype bool - If true the table is made local, otherwise it's unlocalized.
def cmds.LockAttributes (   attr_paths,
  lock 
)

Lock or unlock specified attributes.

Parameters
attr_pathstype string[] - attributes to consider
locktype bool - Specify to lock (true) or unlock (false).
def cmds.LockItem (   item)

Lock item.

Parameters
itemtype item - item to lock
def cmds.LockItems (   items)

Lock items.

Parameters
itemstype string[] - items to lock
def cmds.LockPackageLayers (   build_package_path,
  layer_indices,
  value 
)

Lock/unlock the given layers in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - List of indices of layers to lock/unlock.
valuetype bool - If true, the layers are locked, otherwise they are unlocked.
def cmds.LockTable (   table_path,
  locked 
)

Lock or unlock the whole table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
lockedtype bool - If true the table is locked, otherwise it's unlocked.
def cmds.MakeInstance (   item_names,
  source 
)

Instantiate any item.

Parameters
item_namestype string[] - instances names to be created
sourcetype string - source object to create instances from
def cmds.MakeLocal (   item_names,
  keep_values 
)

Localize any instantiated item.

Parameters
item_namestype string[] -
keep_valuestype bool - if true, each attribute is localized (default), otherwise unlocalized attributes are reset to their default value.
def cmds.MakeLocal (   item_names)

Localize any instantiated item.

Parameters
item_namestype string[] - instance items to be localized
def cmds.MakeLocalContext (   context)

Make local a referenced context.

Parameters
contexttype context - referenced context
def cmds.MakeLocalContexts (   context_paths)

Make local a referenced context.

Parameters
context_pathstype string[] - list of referenced context path
def cmds.MergePackageEditLayers (   build_package_path,
  layer_indices,
  discard_disabled,
  preserve_locked 
)

Merge a list of edit layers into the first one.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - List of indices of edit layers in the build package to merge. If empty, all layers are merged and disabled layers are discarded.
discard_disabledtype bool - If true, the disabled layers in the given list are discarded, otherwise, there are kept.
preserve_lockedtype bool - If true, the locked layers in the given list are kept, otherwise, there are merged.
def cmds.MergeProject (   filenames)

Merge specified project(s) in current context.

Parameters
filenamestype string[] - each filename will be added to current context.
def cmds.MoveItemsTo (   items,
  location 
)

Move items to a specified location.

Parameters
itemstype string[] - items to be moved
locationtype string - where to move the items: at least a context name, eventually a target object name (items will be moved before the target)
def cmds.MoveItemTo (   item,
  location 
)

Move item to a specified location.

Parameters
itemtype string - item to be moved
locationtype string - where to move the item: at least a context name, eventually a target object name (item will be moved before the target)
def cmds.MovePackageLayer (   build_package_path,
  layer_index,
  new_layer_index 
)

Move a layer in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indextype int - Index of the layer to move.
new_layer_indextype int - New index of the layer.
def cmds.MoveParticle (   item,
  ids,
  delta,
  space 
)

Move particles from specified Particle cloud, applying to the particles whom ids are provided a given amount of translation, expressed either in world, object or local space.

Parameters
itemtype string - GeometryParticle to move
idstype int[] - ids of particles to move
deltatype vec3d - amount of translation along each axis in specified space
spacetype int - 0=world, 1=object, 2=local (y=particle normal, z=particle velocity
def cmds.MoveParticle (   item,
  ids,
  positions 
)

Move particles from specified Particle cloud, setting the particles whom ids are provided to specified locations.

Parameters
itemtype string - GeometryParticle to move
idstype int[] - ids of particles to move
positionstype vec3d[] - locations to assign
def cmds.MoveShadingLayerRules (   shading_layer,
  indexes,
  offset,
  is_relative 
)

Move rules positions in a shading layer.

Parameters
shading_layertype string - Related shading layer.
indexestype int[] - indexes which will be affected by the movement.
offsettype int - In relative mode, positive delta to increase position, negative to decrease. In absolute mode, positive target rank.
is_relativetype bool - Choose between relative or absolute offset.
def cmds.MoveShadingLayerRules (   shading_layer,
  indexes,
  move_delta 
)

Move rules positions in a shading layer.

Parameters
shading_layertype string - Related shading layer.
indexestype int[] - indexes which will be affected by the movement.
move_deltatype int - delta movement. Positive int to increase position, negative to decrease.
def cmds.MoveTableRow (   table_path,
  from_index,
  to_index 
)

Move a row to another index, while preserving the relative order of the other rows.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
from_indextype int - Index of the row.
to_indextype int - The index where it should be moved (this'll be its new index after the operation's completed)
def cmds.MoveValue (   attr_path,
  index_from,
  index_to 
)

Move a value from an attribute value index to another.

Parameters
attr_pathtype string - Attribute path.
index_fromtype int - Current index of the value to move.
index_totype int - Destination index where to move the value.
def cmds.MuteLocalValueAttributes (   attr_paths,
  mute 
)

Mute or un-mute local value consideration for specified attributes.

Parameters
attr_pathstype string[] - attributes to mute/un-mute local value
mutetype bool - Specify to mute (true) or un-mute (false).
def cmds.PaintCopy (   source_name,
  context_name,
  wpos,
  rot,
  scl 
)

Creates an object instance with specified translate-rotate-scale.

Parameters
source_nametype string - source item to be instanced
context_nametype string -
wpostype vec3d - instance translate
rottype vec3d - instance rotate
scltype vec3d - instance scale
def cmds.PaintInstance (   source_name,
  context_name,
  wpos,
  rot,
  scl 
)

Creates an object instance with specified translate-rotate-scale.

Parameters
source_nametype string - source item to be instanced
context_nametype string -
wpostype vec3d - instance translate
rottype vec3d - instance rotate
scltype vec3d - instance scale
def cmds.PermutePackageLayers (   build_package_path,
  layer_indices,
  layers_to_reparent,
  new_parent 
)

Reorder all layers in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - New indices for all layers.
layers_to_reparenttype int[] - Indices of layers to reparent.
new_parenttype int - Index of the new parent group layer, -1 for none.
def cmds.PermuteReferenceFilename (   contexts,
  permutations 
)

Permute filename values in the specified contexts.

Parameters
contextstype context[] - Contexts that reference external file.
permutationstype int[] - Permutations to process. Contains exhaustive list of reordered filename values for each specified context, in order. Example: with project://context (which has values [5.1, 3.2, 1.8, 2.4]), specifying the following permutations [3, 1, 2, 0] means that the values become: [2.4, 3.2, 1.8, 5.1].
def cmds.PermuteValues (   attr_paths,
  permutations 
)

Permute values in specified attribute.

Parameters
attr_pathstype string[] - Attribute pathes.
permutationstype int[] - Permutation to process. Contains exhaustive list of reordered attribute values for each specified attribute, in order.Example: With project://object.attribute (which has values [5.1, 3.2, 1.8, 2.4]), specifying the following permutations [3, 1, 2, 0] means that the values become: [2.4, 3.2, 1.8, 5.1]
def cmds.PublishPackagePreset (   build_package_path,
  name,
  is_published 
)

Specify if a preset must be displayed in the attribute editor of a build package.

Parameters
build_package_pathtype string - Full path to a build package.
nametype string - Name of the preset.
is_publishedtype bool - If true, this preset will be exposed in the attribute editor of the build package.
def cmds.RecordObjectsOffsets (   objects)

Record objects transformations as offsets.

(Their transormations will be reset and their offsets set so objects remain still)

Parameters
objectstype string[] - objects which offset will be recorded
def cmds.RemoveAllCAMAttributes (   context_paths)

Remove specified CAM attributes.

Parameters
context_pathstype string[] - contexts to remove CAM attributes from
def cmds.RemoveAllValues (   attr)

Removes all values from specified attributes.

Parameters
attrtype string[] - Attributes to remove values from.
def cmds.RemoveCAMAttribute (   attr_paths)

Remove specified CAM attributes.

Parameters
attr_pathstype string[] - attributes to consider
def cmds.RemoveCurveValue (   attr_pathes,
  key_ids 
)

Remove keys for given attributes.

Parameters
attr_pathestype string[] - Curve or Gradient attributes.
key_idstype int[] - for each channel, count then key ids to be removed
def cmds.RemoveCustomAttribute (   attr_paths)

Remove specified custom attributes.

Parameters
attr_pathstype string[] - attributes to consider
def cmds.RemoveFCurve (   attr_paths)

Remove animation for given attributes.

Parameters
attr_pathstype string[] - related attributes
def cmds.RemoveKey (   attr_pathes,
  ids 
)

Removes animation keys from given attrs with specified ids.

Parameters
attr_pathestype string[] - related attributes
idstype int[] - key ids to remove
def cmds.RemoveKeysAt (   attr_pathes,
  time 
)

Removes animation keys from given attrs at specified time.

Parameters
attr_pathestype string[] - related attributes
timetype float - all keys at this time will be removed
def cmds.RemoveObjectsOffsets (   objects)

Remove objects offsets.

(Set offset to (0, 0, 0) )

Parameters
objectstype string[] - objects which offset will be removed
def cmds.RemovePackageEditLayers (   build_package_path,
  layer_indices 
)

Remove the given edit layers from a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indicestype int[] - List of indices of edit layers in the build package to remove.
def cmds.RemovePackagePreset (   build_package_path,
  name 
)

Remove a preset from a build package.

Parameters
build_package_pathtype string - Full path to a build package.
nametype string - Name of the preset.
def cmds.RemoveParticle (   item,
  ids 
)

Remove particles from specified Particle cloud, decimating the particles whom ids are provided.

Parameters
itemtype string - GeometryParticle to remove from
idstype int[] - ids of particles to decimate
def cmds.RemoveReferenceFilename (   contexts,
  indices 
)

Remove filenames referenced by the specified contexts.

Parameters
contextstype context[] - Contexts that reference external file.
indicestype int[] - Indices of values to be removed.
def cmds.RemoveShadingLayerRules (   shading_layer,
  indexes 
)

Removes rules from a shading layer.

Parameters
shading_layertype string - Related shading layer.
indexestype int[] - indexes to remove. Rules will be removed from greatest to smallest indexes.
def cmds.RemoveTableRow (   table_path)

Remove the last row of an attribute table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
def cmds.RemoveTableRow (   table_path,
  row_index 
)

Remove a specific row of an attribute table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - The index of the row to remove.
def cmds.RemoveTableRows (   table_path,
  row_indices 
)

Remove multiple rows from a table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indicestype int[] - The indices of the rows to remove.
def cmds.RemoveUsdBundleFilename (   attribute_path,
  indices 
)

Remove filename values on the specified USD bundles.

Parameters
attribute_pathtype string[] - Full paths of bundle's filename attributes.
indicestype int[] - List of filename indices to remove.
def cmds.RemoveValue (   attr,
  indices 
)

Removes values from attributes.

Parameters
attrtype string[] - Attributes to remove values from.
indicestype int[] - indices of values to be removed.
def cmds.RenameItem (   item,
  name 
)

Rename an item.

Parameters
itemtype string - Item to be renamed.
nametype string - New item name.
def cmds.RenamePackageLayer (   build_package_path,
  layer_index,
  name 
)

Rename the given layer in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
layer_indextype int - Index of the layer to rename.
nametype string - New name of the layer.
def cmds.RenamePackagePreset (   build_package_path,
  name,
  new_name 
)

Rename a preset in a build package.

Parameters
build_package_pathtype string - Full path to a build package.
nametype string - Name of the preset.
new_nametype string - New name to give to the preset.
def cmds.RenameParticlesProperty (   items,
  name,
  new_name 
)

Rename a given property for the specified Particle cloud(s).

Parameters
itemstype string[] - GeometryParticle objects to modify
nametype string - property to rename
new_nametype string - new name to apply
def cmds.ResetAttributes (   attributes)

Reset the attributes to its default value.

Parameters
attributestype string[] - Array of attributes to get reset.
def cmds.ResetObjectsPivots (   objects)

Reset objects pivots.

Parameters
objectstype string[] - objects which pivot will be reset
def cmds.ResetObjectsPivots (   objects,
  use_global_pivot 
)

Reset objects pivots.

Parameters
objectstype string[] - objects which pivots will be reset
use_global_pivottype bool - locate on global pivot if true, reset to (0,0,0) otherwise.
def cmds.ResetObjectsTransform (   objects)

Reset objects transformation matrix.

Parameters
objectstype string[] - objects full names
def cmds.ResetTable (   table_path)

Reset the whole table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
def cmds.RevertAttributes (   attributes)

Revert attribute to its initial(deserialized) value.

Parameters
attributestype string[] - Array of attributes to get restored.
def cmds.RevertItemsOverrides (   items)

Revert overrides on specified items.

Parameters
itemstype string[] - Array of items to restore.
def cmds.RevertSubItemsOverrides (   items)

Revert overrides on sub-items of specified items.

Parameters
itemstype string[] - Array of items used to filter overrides to restore.
def cmds.RevertTable (   table_path)

Revert the whole table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
def cmds.SetAutofitMode (   attr_path,
  values,
  indices 
)

Enable/disable backdrop autofitting.

Parameters
attr_pathtype string[] - Backdrop(s) attribute path(es).
valuestype string[] - contains 1 value, the autofit mode
indicestype int[] - always contains one value: 0
def cmds.SetChannel (   attr_pathes,
  channel 
)

Set channel for specified attribute.

Parameters
attr_pathestype string[] -
channeltype string -
def cmds.SetCurrentFrame (   frame)

Set application current frame.

Parameters
frametype float - new current frame
def cmds.SetCurrentFrameRange (   min,
  max 
)

Set application current frame range.

Parameters
mintype float - new range min
maxtype float - new range max
def cmds.SetCurrentFrameRangeMax (   max)

Set application current frame range max.

Parameters
maxtype float - new range max
def cmds.SetCurrentFrameRangeMin (   min)

Set application current frame range min.

Parameters
mintype float - new range min
def cmds.SetCurrentTime (   time)

Set application current time.

Parameters
timetype float - new current time
def cmds.SetCurve (   attr_pathes,
  serial,
  behaviors 
)

Set curve for specified attributes (replace any existing curve).

Parameters
attr_pathestype string[] - Attributes paths: referring to a multidimensional attribute without index is a shortcut for all channels.
serialtype float[] - Serialized curve(s). Format: one or several blocks [k_count, k1_type, k1_x, k1_y,..., kn_type, kn_x, kn_y].
Optional behavior values can be specified as [pre_behavior, post_behavior] for each curve.
Curves are applied cyclically to attributes.
behaviorstype bool - True if pre/post behaviors are specified as described above.
def cmds.SetCurveExtrapolationMode (   attr_pathes,
  behavior,
  where 
)

Set curve extrapolation mode for specified attributes.

Parameters
attr_pathestype string[] - Related attributes
behaviortype int - Extrapolation behavior. See FCurve documentation for available values
wheretype int - 1=pre, 2=post, 3=both (default)
def cmds.SetCurveKeyPosition (   attr_pathes,
  positions,
  key_ids 
)

Set keys positions for specified attributes.

Parameters
attr_pathestype string[] - Gradient attributes.
positionstype float[] - positions set
key_idstype int[] - key ids to which positions will be replaced
def cmds.SetCurveKeyType (   attr_pathes,
  serial 
)

Set keys types for specified attributes.

Parameters
attr_pathestype string[] - Related attributes
serialtype int[] - Serialized channel/key/type triplets [chan_1, k1_id, k1_type, ..., chan_n, kn_id, kn_type]
def cmds.SetCurveKeyValue (   attr_pathes,
  values,
  key_ids 
)

Set keys values for specified attributes.

Parameters
attr_pathestype string[] - Gradient attributes.
valuestype float[] - values to be set
key_idstype int[] - key ids to which values will be replaced
def cmds.SetExpression (   attr_fullnames,
  expressions 
)

Set the expression for specified attribute values.

Parameters
attr_fullnamestype string[] - attribute full names, each attribute can specify value index using indexation operator at the end of the attribute name (eg. [0] to specify the first value only), otherwise all the values of the attribute will be setted.
expressionstype string[] - specifies the expression for each specified attributes values.
def cmds.SetFps (   value)

Set application Fps.

Parameters
valuetype float - new fps value
def cmds.SetItemNodalProperty (   item,
  position,
  prop,
  slot 
)

Sets item property in nodal.

Parameters
itemtype string - item to set position and property for
positiontype vec2i - item position
proptype int - item property
slottype string - related property slot
def cmds.SetItemNodalProperty (   item,
  prop,
  slot 
)

Sets item property in nodal.

Parameters
itemtype string - item to set property for
proptype int - item property
slottype string - related property slot
def cmds.SetItemPosition (   item,
  item_position,
  position_slot 
)

Sets item position in nodal.

Parameters
itemtype string - items to set positions for
item_positiontype vec2i - item position
position_slottype string - related position slot
def cmds.SetItemsNodalProperties (   items,
  positions,
  props,
  slot 
)

Sets items properties in nodal.

Parameters
itemstype string[] - items to set positions and properties for
positionstype vec2i[] - items positions
propstype int[] - items properties
slottype string - related property slot
def cmds.SetItemsNodalProperties (   items,
  props,
  slot 
)

Sets items properties in nodal.

Parameters
itemstype string[] - items to set properties for
propstype int[] - items properties
slottype string - related property slot
def cmds.SetItemsPositions (   items,
  items_positions,
  position_slot 
)

Sets items position in nodal.

Parameters
itemstype string[] - items to set positions for
items_positionstype vec2i[] - items positions
position_slottype string - related position slot
def cmds.SetItemViewPoint (   item_name,
  px,
  py,
  pz,
  rx,
  ry,
  rz,
  ad 
)

Set item view point.

Parameters
item_nametype string - item full path
pxtype float - position x
pytype float - position y
pztype float - position z
rxtype float - rotate x
rytype float - rotate y
rztype float - rotate z
adtype float - aim distance
def cmds.SetKey (   attr_pathes,
  time,
  values,
  type 
)

Add an animation key in one or more attributes.

Parameters
attr_pathestype string[] - Related attributes
timetype float - new keys time
valuestype float[] - new keys values
typetype int - new keys type
def cmds.SetKeysPropertyValues (   attr_pathes,
  key_ids,
  property_name,
  property_values 
)

Sets keyframe property value.

Parameters
attr_pathestype string[] - related attributes
key_idstype int[] - related keyframe ids
property_nametype string - property to set. See FCurve documentation for list of property names.
property_valuestype string[] - property values, one for each specified key_id
def cmds.SetKeyTangents (   attr_path,
  key_id,
  tangents_values 
)

Sets keyframe tangents values.

Parameters
attr_pathtype string - related attribute
key_idtype int - related keyframe id
tangents_valuestype float[] - tangent values. The array must be structured like this:
first value specifies which tangents will be modified and MUST be equal to 1 (for tangent1) 2 (for tangent 2) or 3 (for both tangents).
following values are the x and y values for tangents specified in the first array value.
example: [1, 0.89, 0.68] or [3, 0.5, 0.5, 0.2, 0.1]
def cmds.SetObjectsGlobalTransform (   objects,
  values 
)

Set objects global transformation matrix.

Parameters
objectstype string[] - objects full names
valuestype matrix4x4d[] - matrixes to set
def cmds.SetObjectsLocalTransform (   objects,
  values 
)

Set objects local transformation matrix.

Parameters
objectstype string[] - objects full names
valuestype matrix4x4d[] - matrixes to set
def cmds.SetOutputBinding (   attrs,
  plug_output 
)

Connect an output plug to specified attributes.

Parameters
attrstype string[] - Attributes to bind.
plug_outputtype string - Output plug binding.
def cmds.SetParent (   attr_path,
  values,
  indices 
)

Set the parent kinematic object.

Parameters
attr_pathtype string[] - Group objects attribute pathes.
valuestype string[] - contains 1 value, the object to use as a kinematic parent
indicestype int[] - always contains one value: 0
def cmds.SetParentInPlace (   value)

Set application parent in place.

Parameters
valuetype bool - new parent in place value
def cmds.SetReferenceFilename (   contexts,
  filename 
)

Sets the filename that will be referenced by the specified contexts.

Parameters
contextstype context[] - Contexts that reference external file.
filenametype string - Full name of the external file.
def cmds.SetReferenceFilenames (   contexts,
  indices,
  filenames 
)

Sets the filenames that will be referenced by the specified contexts.

Parameters
contextstype context[] - Contexts that reference external file.
indicestype int[] - Indices of values to be set
filenamestype string[] - Full name of the external files.
def cmds.SetShadingLayerRulesProperty (   shading_layer,
  indexes,
  property_name,
  property_values 
)

Set values for a property of shading layer rules.

Parameters
shading_layertype string - Related shading layer.
indexestype int[] - indexes which will be affected by the property set.
property_nametype string - Property name to be affected:
'filter' to set rule filter.
'is_visible' to set rule visibility ('0' or '1')
'material' to set rule material (requires an object full name).
property_valuestype string[] - Values of the specified property for all rules at given indexes.
def cmds.SetTableCell (   table_path,
  row_index,
  column_index,
  value 
)

Set an attribute table's cell values.

Set an attribute table's cell value.

The number of values must match the stride of the column (e.g. if the column is a 'double[3]' you must provide 3 values)

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - Index of the row.
column_indextype int - Index of the column.
valuestype unknown - The list of values for the cell.

This works on single valued cells.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - Index of the row.
column_indextype int - Index of the column.
valuetype unknown - The value for the cell.
def cmds.SetTableCell (   table_path,
  row_index,
  column_index,
  value,
  value_index 
)

Set an attribute table's cell value.

This will work on cells with multiple values (for instance a 'color' or 'double[3]' cell) to set a single value.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - Index of the row.
column_indextype int - Index of the column.
valuetype unknown - The value for the cell.
value_indextype int - Index of the value in the cell.
def cmds.SetTableRow (   table_path,
  row_index,
  values 
)

Set an attribute table's row values.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
row_indextype int - Index of the row to set.
valuestype unknown - The list of values for the row.
def cmds.SetTexture (   attrs,
  texture 
)

Set a texture for specified attributes.

Parameters
attrstype string[] - Attribute to set texture to.
texturetype string - Texture to set to attributes
def cmds.SetUsdBundleFilename (   attribute_paths,
  values,
  indices 
)

Set filename values on the specified USD bundles.

Parameters
attribute_pathstype string[] - List of full paths of bundle's filename attributes.
valuestype string[] - List of filename values, in the form [bundle_i_value_0, ... bundle_j_value_0, ...].
indicestype int[] - List of filename value indices, in the form [bundle_i_index_0, ... bundle_j_index_0, ...].
def cmds.SetValue (   attr,
  values 
)

Sets the values of an attribute.

Parameters
attrtype string - Attribute to set value to.
valuestype string[] - values to set.
def cmds.SetValueCount (   attrs,
  counts 
)

Sets the number of values of specified attributes.

Parameters
attrstype string[] - Attributes to set the number of values.
countstype int[] - New number of values to set to the attributes
def cmds.SetValues (   attrs,
  values 
)

Sets the values for multiple attributes.

Parameters
attrstype string[] - Attributes to set value to.
valuestype string[] - values to be set.
def cmds.SwapTableRows (   table_path,
  first_index,
  second_index 
)

Swap 2 rows of an attribute table.

Parameters
table_pathtype string - Full path to an attribute table. It works like an attribute full name, the only difference being that the last part is the table name instead of an attribute name. For instance: "project://some_context/some_object.table_name"
first_indextype int - Index of the first row.
second_indextype int - Index of the second row.
def cmds.TrashItems (   items)

Not undoable delete items command.

Will ask to clear the command history.

Parameters
itemstype string[] - Items to trash.
def cmds.UnbindShadingVariable (   attr_paths)

Unbinds multiple attributes from a shading variable.

Parameters
attr_pathstype string[] - Attribute to set value to.
def cmds.UngroupPackageLayers (   build_package_path,
  group_indices,
  preserve_locked 
)

Remove group layers from a build package.

Parameters
build_package_pathtype string - Full path to a build package.
group_indicestype int[] - List of indices of group layers to remove. For each group, the child layers are reparented to upper group if any.
preserve_lockedtype bool - If true, the locked groups in the given list are kept, otherwise, there are removed.
def cmds.UnlockItem (   item)

Unlock item.

Parameters
itemtype item - item to unlock
def cmds.UnlockItems (   items)

Unlock items.

Parameters
itemstype string[] - items to unlock