csc.update.ObjectGroup

class csc.update.ObjectGroup

ObjectGroup class represents object group node

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

add_input(self, name)

add_output(self, name)

attributes(self, d)

array of all input and output attributes

constant_datas(self)

get virtual node to access constant datas

constant_settings(self)

get virtual node to access constant settings

create_group(self, name)

create_object(*args, **kwargs)

Overloaded function.

create_sub_object_group(self, name)

-> ObjectGroup

delete_node(self, node)

full_name(self)

name with all the parent nodes

group(self, nodes, name)

group_id(self)

create sub group

has_input(self, name)

check if there is an input with such a name

has_node(self, name)

check whether there is a child node with a given name

has_output(self, name)

check if there is an output with such a name

id(self)

get uniqui id

input(self, name)

shortcut if node has only one input attribute

input_interface_node(self)

inputs(self)

array of all the inputes attributes

interface_input(self, name)

interface_inputs(self)

get group attributes as interface attributes

interface_node(self, direction)

access the interface node

interface_output(self, name)

interface_outputs(self)

is_active(self)

check whether it is active for current actualities states (see Additional functionality in csc.update.UpdateEditor)

is_fictive(self)

whether it is a fictive node (constants, inputs, outputs of a group or external properties)

is_root(self)

leaf_children(self)

get all leaf nodes (settings, datas, functions)

name(self)

get name

node(*args, **kwargs)

Overloaded function.

node_deep(self, name)

access node by name or id recursively

node_with_type(self, type_name, name)

find node with name and type

node_with_type_deep(self, type_name, name)

find node with name and type recursively

nodes(self)

get all children (their children are not included)

object_groups(self)

-> ObjectGroup{}

objects(self)

-> Object{}

output(self, name)

shortcut if node has only one output attribute

output_interface_node(self)

outputs(self)

array of all the outputs attributes

parent_group(self)

return parent group (where this group node is located)

parent_object(self)

return object of the node.

set_name(self, name)

rename node

__annotations__ = {}
__init__(*args, **kwargs)
__module__ = 'csc.update'
create_object(*args, **kwargs)

Overloaded function.

  1. create_object(self: csc.update.ObjectGroup, name: str) -> csc.update.Object

  2. create_object(self: csc.update.ObjectGroup, name: str, id: csc.model.ObjectId) -> csc.update.Object

create_sub_object_group(self: csc.update.ObjectGroup, name: str) csc.update.ObjectGroup

-> ObjectGroup

object_groups(self: csc.update.ObjectGroup) Set[csc.update.ObjectGroup]

-> ObjectGroup{}

objects(self: csc.update.ObjectGroup) Set[csc.update.Object]

-> Object{}