ComponentSystem Class

ComponentSystem Class

Members

ComponentSystem * get ( ) #

ComponentSystem *cs = ComponentSystem::get();
// access functions of C++ Component System
...

void initialize ( ) #

virtual int AppSystemLogic::init()
{
	// initialize ComponentSystem and register all components
	ComponentSystem::get()->initialize();

	/*...*/
	
	return 1;
}

int getNumComponents ( ) #

Return value

int getNumNodesWithComponents ( ) #

Return value

template <C class>

void createPropertyFile ( ) #

void createPropertyFile ( const char * name ) #

Arguments

• const char * name - Name of the property associated with the component.

void createPropertyFiles ( ) #

void refreshProperty ( const char * name ) #

Arguments

• const char * name - Property name.

template <C class>

void refreshProperty ( ) #

template <C class>

void registerComponent ( ) #

virtual int AppSystemLogic::init()
{
	// registering a new user component
	ComponentSystem::get()->registerComponent<MyComponent>();

	/*...*/
	
	return 1;
}

template <C class>

C * addComponent ( const NodePtr & node ) #

NodeDummyPtr node = NodeDummy::create();
node->setName("node_dummy");



ComponentSystem::get()->addComponent<MyComponent>(node->getNode());
// now the node named node_dummy appears in the Editor

Arguments

• const NodePtr & node - Node, to which the component is to be added.

Return value

template <C class>

C * getComponent ( const NodePtr & node ) #

Arguments

• const NodePtr & node - Node, for which the component of the specified type is to be found.

Return value

template <C class>

void getComponents ( const NodePtr & node, Vector<C *> & out_components, int clear_vector ) #

Arguments

• const NodePtr & node - Node, for which the components of the specified type are to be found.
• Vector<C *> & out_components - Buffer vector, to which all found components of the specified type will be added.
• int clear_vector - Flag indicating whether the buffer vector is to be cleared before adding the found components to it or not. Use 1 to clear the vector, 0 - to append new found components to the end of the vector. The default value is 1.

template <C class>

C * getComponentInChildren ( const NodePtr & node ) #

• node itself
• node reference
• node's children
• children of node's children

Arguments

• const NodePtr & node - Node, whose hierarchy is to be checked for the specified type of component.

Return value

template <C class>

void getComponentsInChildren ( const NodePtr & node, Vector<C *> & out_components, int clear_vector ) #

Arguments

• const NodePtr & node - Node, whose hierarchy is to be checked.
• Vector<C *> & out_components - Buffer vector, to which all found components of the specified type will be added.
• int clear_vector - Flag indicating whether the buffer vector is to be cleared before adding the found components to it or not. Use 1 to clear the vector, 0 - to append new found components to the end of the vector. The default value is 1.

template <C class>

C * getComponentInParent ( const NodePtr & node ) #

Arguments

• const NodePtr & node - Node, whose hierarchy is to be checked.

Return value

template <C class>

void getComponentsInParent ( const NodePtr & node, Vector<C *> & out_components, int clear_vector ) #

Arguments

• const NodePtr & node - Node, whose hierarchy is to be checked.
• Vector<C *> & out_components - Buffer vector, to which all found components of the specified type will be added.
• int clear_vector - Flag indicating whether the buffer vector is to be cleared before adding the found components to it or not. Use 1 to clear the vector, 0 - to append new found components to the end of the vector. The default value is 1.

template <C class>

int removeComponent ( const NodePtr & node ) #

// removes a user component MyComponent from the node
ComponentSystem::get()->removeComponent<MyComponent>(some_node);

Arguments

• const NodePtr & node - Node, from which the component is to be removed.

Return value

void setWarningLevel ( int level ) #

Arguments

• int level - New warning level to be set. One of the following values:
  • WARNING_LEVEL::NONE - warning messages are disabled.
  • WARNING_LEVEL::LOW - warning messages are generated only for serious cases.
  • WARNING_LEVEL::HIGH - warning messages are generated for all cases including potential ones. At this level, for example, all Node/Property/Material parameters, that are empty at startup, will be reported.

int getWarningLevel ( ) #

Return value

• WARNING_LEVEL::NONE - warning messages are disabled.
• WARNING_LEVEL::LOW - warning messages are generated only for serious cases.
• WARNING_LEVEL::HIGH - warning messages are generated for all cases including potential ones. At this level, for example, all Node/Property/Material parameters, that are empty at startup, will be reported.