csc.layers.Viewer¶

class csc.layers.Viewer¶

Viewer class

This class contains all methods and properties that describe the structure of scene objects’ interpolation properties. The structure is represented in the hierarchy of layers divided by folders.

Variables:

top_layer_id – overridden method by ItemId || ItemId[]
merged_layer – overridden method like static and member LayerId[]
last_key_pos – overridden method by LayerId[], -> Layer
frames_count – overridden method by LayerId[], -> int
significant_frames – overridden method by LayerId{}, -> int{}

__init__(*args, **kwargs)¶

Methods

`__init__`(args, *kwargs)
`actual_key_pos`(self, pos)
`all_child_ids`(self, id)	-> ItemId[]
`all_included_layer_ids`(self, items[, ...])	items : ItemId[] \| ignoreLocked : bool (false) \| -> LayerId[]
`all_layer_ids`(self)	-> LayerId[]
`all_parent_ids`(self, id)	-> FolderId[]
`default_layer_id`(self)	-> LayerId
`find_folder`(self, id)	id : FolderId \| -> Folder
`find_layer`(self, id)	id : LayerId \| -> Layer
`folder`(self, id)	id : FolderId \| -> Folder
`folders_map`(self)	-> <FolderId, Folder>{}
`for_all_ordered_items`(self, arg0)
`frames_count`(args, *kwargs)	Overloaded function.
`has_item`(self, id)	-> bool
`header`(self, id)	id : ItemId \| -> Header
`is_deep_child`(self, item_id, folder_id)	-> bool
`item`(self, id)	id : ItemId \| -> ItemVariant
`last_key_pos`(args, *kwargs)	Overloaded function.
`layer`(self, id)	id : LayerId \| -> Layer
`layer_id_by_obj_id`(self, id)	id : csc.model.ObjectId \| -> LayerId
`layer_id_by_obj_id_or_null`(self, id)	id : csc.model.ObjectId \| -> LayerId
`layer_ids_by_obj_ids`(self, ids)	ids : csc.model.ObjectId[] \| -> LayerId{}
`layers_indices`(self, id_arr, ignore_locked)	-> IndicesContainer
`layers_map`(self)	-> <LayerId, Layer>{}
`merged_layer`(self, scene, ids, normalize)
`obj_ids_by_layer_ids`(self, id_arr)	-> LayerId[]
`pos_in_parent`(self, id)	-> int
`root_id`(self)	-> FolderId
`significant_frames`(args, *kwargs)	Overloaded function.
`top_layer_id`(args, *kwargs)	Overloaded function.
`unlocked_layer_ids`(self, id_arr)	-> LayerId[]

__annotations__ = {}¶

__init__(*args, **kwargs)¶

__module__ = 'csc.layers'¶

actual_key_pos(self: csc.layers.Viewer, pos: int) → int¶

all_child_ids(self: csc.layers.Viewer, id: csc.Guid) → List[csc.Guid]¶: -> ItemId[]

all_included_layer_ids(self: csc.layers.Viewer, items: List[csc.Guid], ignore_locked: bool = False) → List[csc.Guid]¶: items : ItemId[] | ignoreLocked : bool (false) | -> LayerId[]

all_layer_ids(self: csc.layers.Viewer) → List[csc.Guid]¶: -> LayerId[]

all_parent_ids(self: csc.layers.Viewer, id: csc.Guid) → List[csc.Guid]¶: -> FolderId[]

default_layer_id(self: csc.layers.Viewer) → csc.Guid¶: -> LayerId

find_folder(self: csc.layers.Viewer, id: csc.Guid) → object¶: id : FolderId | -> Folder

find_layer(self: csc.layers.Viewer, id: csc.Guid) → object¶: id : LayerId | -> Layer

folder(self: csc.layers.Viewer, id: csc.Guid) → object¶: id : FolderId | -> Folder

folders_map(self: csc.layers.Viewer) → Dict[csc.Guid, csc.layers.Folder]¶: -> <FolderId, Folder>{}

for_all_ordered_items(self: csc.layers.Viewer, arg0: Callable[[csc.Guid], bool]) → None¶

frames_count(*args, **kwargs)¶

Overloaded function.

frames_count(self: csc.layers.Viewer) -> int
frames_count(self: csc.layers.Viewer, id_arr: List[csc.Guid]) -> int

has_item(self: csc.layers.Viewer, id: csc.Guid) → bool¶: -> bool

header(self: csc.layers.Viewer, id: csc.Guid) → object¶: id : ItemId | -> Header

is_deep_child(self: csc.layers.Viewer, item_id: csc.Guid, folder_id: csc.Guid) → bool¶: -> bool

item(self: csc.layers.Viewer, id: csc.Guid) → csc.layers.ItemVariant¶: id : ItemId | -> ItemVariant

last_key_pos(*args, **kwargs)¶

Overloaded function.

last_key_pos(self: csc.layers.Viewer) -> int
last_key_pos(self: csc.layers.Viewer, id_arr: List[csc.Guid]) -> int

layer(self: csc.layers.Viewer, id: csc.Guid) → object¶: id : LayerId | -> Layer

layer_id_by_obj_id(self: csc.layers.Viewer, id: common::GenericId<domain::scene::model::ModelObject>) → csc.Guid¶: id : csc.model.ObjectId | -> LayerId

layer_id_by_obj_id_or_null(self: csc.layers.Viewer, id: common::GenericId<domain::scene::model::ModelObject>) → csc.Guid¶: id : csc.model.ObjectId | -> LayerId

layer_ids_by_obj_ids(self: csc.layers.Viewer, ids: List[common::GenericId<domain::scene::model::ModelObject>]) → Set[csc.Guid]¶: ids : csc.model.ObjectId[] | -> LayerId{}

layers_indices(self: csc.layers.Viewer, id_arr: domain::scene::layers::index::IndicesContainer, ignore_locked: bool = False) → domain::scene::layers::index::IndicesContainer¶: -> IndicesContainer

layers_map(self: csc.layers.Viewer) → Dict[csc.Guid, csc.layers.Layer]¶: -> <LayerId, Layer>{}

merged_layer(self: csc.layers.Viewer, scene: domain::scene::Scene, ids: List[csc.Guid], normalize: bool = True) → csc.layers.Layer¶

obj_ids_by_layer_ids(self: csc.layers.Viewer, id_arr: List[csc.Guid]) → List[common::GenericId<domain::scene::model::ModelObject>]¶: -> LayerId[]

pos_in_parent(self: csc.layers.Viewer, id: csc.Guid) → int¶: -> int

root_id(self: csc.layers.Viewer) → csc.Guid¶: -> FolderId

significant_frames(*args, **kwargs)¶

Overloaded function.

significant_frames(self: csc.layers.Viewer) -> domain::scene::layers::index::FramesIndices
significant_frames(self: csc.layers.Viewer, id_arr: Set[csc.Guid]) -> domain::scene::layers::index::FramesIndices

top_layer_id(*args, **kwargs)¶

Overloaded function.

top_layer_id(self: csc.layers.Viewer, id: csc.Guid) -> csc.Guid
top_layer_id(self: csc.layers.Viewer, id_arr: List[csc.Guid]) -> csc.Guid

unlocked_layer_ids(self: csc.layers.Viewer, id_arr: List[csc.Guid]) → List[csc.Guid]¶: -> LayerId[]