NodeDelegate

Inheritance diagram of rumba.NodeDelegate
class NodeDelegate

This interface gives a high level access to the document structure.

Using this class, not only the API nodes structure can be traversed but also the values.

The values can present a hierarchical structure which is managed by the value itself.

For exemple, a USD reader Rumba node exposes the USD file structure to the Rumba user interface with special USD values and a specialized NodeDelegate.

This class can be used to traverse the document in a user interface.

Deriving this class, one can also define a value internal hierarchy.

Those objects are invalid if the document structure changes. So they shall be keeped only during the traversal and not used if the current node has been destroyed.

If you need to keep references on a node, use a path on this node. The path is a string like “/nodeA/nodeB/nodeC.plugA/nodeD/nodeE”. Here “nodeA”, “nodeB” and “nodeC” are valid rumba:Node objects. “plugA” is the name of a plug of “nodeC”. “nodeD” and “nodeE” are nodes served by the value stored in “plugA”. “nodeD” and “nodeE” do not really exist in the document.

Methods

__eq__

Return self==value.

__getattr__

__ne__

Return self!=value.

attribute(name)

Return a node attribute using its name.

attribute_count()

Returns the number of attributes.

center_of_interest

child(name)

Return a node child using its name.

child_count()

Returns the number of children in the node.

create_transform_observer(func, in_interactive)

type in_interactive

bool

far_clipping_plane

find(path)

Returns descendent node_delegate using a path starting at this node.

focal_length

has_transform()

Return true if this node is has a transformation matrix.

horizontal_aperture

is_camera()

Returns true if this node is a camera.

is_node()

Return true if this node delegate is a Rumba Node.

is_orthographic

joint_orient

matrix

mutable_flags()

Returns the mutable transformation component.

name()

The node's name.

near_clipping_plane

node()

Return the node behind this node delegate.

orthographic_width

parent()

Returns the parent node.

parent_world_matrix

path()

Returns the full path to the node.

rotate_order

rotate_pivot

rotation

scale

scale_pivot

set_center_of_interest(coi, mc)

Set the center of interest.

set_far_clipping_plane(far_clipping_plane, mc)

Set the far clipping plane.

set_focal_length(fl, mc)

Set the focal length, in mm.

set_horizontal_aperture(horizontal_aperture, mc)

Set the horizontal aperture, in cm.

set_near_clipping_plane(near_clipping_plane, mc)

Set the near clipping plane.

set_orthographic_width(width, mc)

Set the orthographic width.

set_rotation

set_scale

set_translation

set_vertical_aperture(vertical_aperture, mc)

Set the vertical aperture, in cm.

start_transform

translation

type_name

ui_description()

Return UI description for this node delegate, empty if not specified.

vertical_aperture

world_matrix