Script
Properties | List of all members
CompositionItem Class Reference

A class that represent a single entry in the composition order. The composition order is an array of this composition item. More...

#include <compositioninterface.h>

Inheritance diagram for CompositionItem:
Inheritance graph
[legend]
Collaboration diagram for CompositionItem:
Collaboration graph
[legend]

Properties

String node
 name of this node ( see node interface )
 
bool isNodeRoot
 true when this node is a root (it has no parent).
 
bool isNodeNormal
 true when this node is a normal node and has a parent.
 
bool isNodeBroken
 true when this node has a parent but the parent is not present in the composition. Some modules, such as composite module, are never listed in the composition, however, they can be the parent of some other modules that will be listed in the composition.
 
bool isNodeSubnodeRoot
 parent less node that is within a child group.
 
unsigned numChildren
 number of children listed in the composition attached to node.
 
unsigned depth
 depth level of this node. Depths starts at zero for parent less node and increases for every level of parent this node has.
 

Detailed Description

A class that represent a single entry in the composition order. The composition order is an array of this composition item.

Represent a single entry in the composition order. The composition order is an array of this composition item. The composition is actually a vector of these composition item. Each item contains all the information for rebuilding the composition.

Property Documentation

unsigned CompositionItem::depth
read

depth level of this node. Depths starts at zero for parent less node and increases for every level of parent this node has.

bool CompositionItem::isNodeBroken
read

true when this node has a parent but the parent is not present in the composition. Some modules, such as composite module, are never listed in the composition, however, they can be the parent of some other modules that will be listed in the composition.

bool CompositionItem::isNodeNormal
read

true when this node is a normal node and has a parent.

bool CompositionItem::isNodeRoot
read

true when this node is a root (it has no parent).

bool CompositionItem::isNodeSubnodeRoot
read

parent less node that is within a child group.

String CompositionItem::node
read

name of this node ( see node interface )

unsigned CompositionItem::numChildren
read

number of children listed in the composition attached to node.


The documentation for this class was generated from the following file: