csc.tools.RiggingModeTool

class csc.tools.RiggingModeTool

Rigging mode tool class

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

erase_joints_data(self, arg0)

Erases joint data for the specified session.

erase_layer_id_by_object_ids(self, arg0)

Erases layer ID mapped by object IDs for the specified session.

erase_layers_ids(self, arg0)

Erases layer IDs for the specified session.

erase_preserved_data(self, arg0)

Erases preserved data for the specified session.

erase_preserved_object_ids(self, arg0)

Erases preserved object IDs for the specified session.

erase_preserved_setting(self, arg0)

Erases preserved setting for the specified session.

get_joints_data(self)

Retrieves joint data mapped by object ID.

get_layer_id_by_object_ids(self)

Retrieves layer ID mapped by object IDs.

get_layers_ids(self)

Retrieves layer IDs as a set of GUIDs.

get_preserved_data(self)

Retrieves preserved data stored in a dictionary structure.

get_preserved_object_ids(self)

Retrieves preserved object IDs stored in a set.

get_preserved_setting(self)

Retrieves preserved setting stored in a dictionary structure.

set_joints_data(self, arg0, arg1)

Sets joint data for the specified session.

set_layers_ids(self, arg0, arg1)

Sets layer IDs for the specified session.

set_preserved_data(self, arg0, arg1)

Sets preserved data for the specified session.

set_preserved_object_ids(self, arg0, arg1)

Sets preserved object IDs for the specified session.

set_preserved_setting(self, arg0, arg1)

Sets preserved setting for the specified session.

set_undo_redo_context(self, arg0, arg1, ...)

Sets undo and redo context for the specified session.
__annotations__ = {}
__init__(*args, **kwargs)
__module__ = 'csc.tools'
erase_joints_data(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session) → None

Erases joint data for the specified session.

Parameters:

arg0 (csc.domain.Session) – Session

erase_layer_id_by_object_ids(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session) → None

Erases layer ID mapped by object IDs for the specified session.

Parameters:

arg0 (csc.domain.Session) – Session

erase_layers_ids(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session) → None

Erases layer IDs for the specified session.

Parameters:

session (csc.domain.Session) – Session

erase_preserved_data(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session) → None

Erases preserved data for the specified session.

Parameters:

arg0 (csc.domain.Session) – Session

erase_preserved_object_ids(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session) → None

Erases preserved object IDs for the specified session.

Parameters:

arg0 (csc.domain.Session) – Session

erase_preserved_setting(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session) → None

Erases preserved setting for the specified session.

Parameters:

arg0 (csc.domain.Session) – Session

get_joints_data(self: csc.tools.RiggingModeTool) → dict[csc.model.ObjectId, list[csc.tools.JointData]]

Retrieves joint data mapped by object ID.

Returns:

Joint data

Return type:

Dict[csc.tools.rigging_mode.ObjectKey, csc.tools.rigging_mode.JointData]

get_layer_id_by_object_ids(self: csc.tools.RiggingModeTool) → dict[csc.Guid, list[csc.model.ObjectId]]

Retrieves layer ID mapped by object IDs.

Returns:

Layer ID mapped by object IDs

Return type:

Set[csc.model.LayerId]

get_layers_ids(self: csc.tools.RiggingModeTool) → set[csc.Guid]

Retrieves layer IDs as a set of GUIDs.

Returns:

Layer IDs

Return type:

Set[csc.Guid]

get_preserved_data(self: csc.tools.RiggingModeTool) → dict[csc.tools.DataKey, list[bool | int | float | numpy.ndarray[numpy.float32[3, 1]] | numpy.ndarray[numpy.float32[4, 1]] | csc.math.Rotation | numpy.ndarray[numpy.float32[3, 3]] | numpy.ndarray[numpy.float32[4, 4]] | csc.math.Quaternion | str | numpy.ndarray[bool[3, 1]]]]

Retrieves preserved data stored in a dictionary structure.

Returns:

Preserved data

Return type:

Dict[csc.tools.DataKey, List[Union[bool, int, float, numpy.ndarray, csc.math.Rotation, csc.math.Quaternion, str]]]

get_preserved_object_ids(self: csc.tools.RiggingModeTool) → dict[csc.model.PathName, csc.model.ObjectId]

Retrieves preserved object IDs stored in a set.

Returns:

Preserved object IDs

Return type:

Dict[PathName,csc.model.ObjectId]

get_preserved_setting(self: csc.tools.RiggingModeTool) → dict[csc.tools.DataKey, list[bool | int]]

Retrieves preserved setting stored in a dictionary structure.

Returns:

Preserved setting

Return type:

Dict[csc.tools.DataKey, List[Union[bool, int]]]

set_joints_data(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session, arg1: dict[csc.model.ObjectId, list[csc.tools.JointData]]) → None

Sets joint data for the specified session.

Parameters:
set_layers_ids(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session, arg1: set[csc.Guid]) → None

Sets layer IDs for the specified session.

Parameters:
set_preserved_data(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session, arg1: dict[csc.tools.DataKey, list[bool | int | float | numpy.ndarray[numpy.float32[3, 1]] | numpy.ndarray[numpy.float32[4, 1]] | csc.math.Rotation | numpy.ndarray[numpy.float32[3, 3]] | numpy.ndarray[numpy.float32[4, 4]] | csc.math.Quaternion | str | numpy.ndarray[bool[3, 1]]]]) → None

Sets preserved data for the specified session.

Parameters:
set_preserved_object_ids(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session, arg1: dict[csc.model.PathName, csc.model.ObjectId]) → None

Sets preserved object IDs for the specified session.

Parameters:
set_preserved_setting(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session, arg1: dict[csc.tools.DataKey, list[bool | int]]) → None

Sets preserved setting for the specified session.

Parameters:
set_undo_redo_context(self: csc.tools.RiggingModeTool, arg0: csc.domain.Session, arg1: Callable, arg2: object, arg3: object) → None

Sets undo and redo context for the specified session.

Parameters: