Drag[en]gine Script Module DragonScript Script API  1.0
FindByClassnameProcessor Class Reference
Inheritance diagram for FindByClassnameProcessor:
ElementProcessor

Public Member Functions

String getClassname ()
 
Element getElement (int index)
 
int getElementCount ()
 
FindByClassnameProcessor new (String className)
 
bool processElement (Element element)
 

Protected Member Functions

void addElement (Element element)
 

Detailed Description

Builds a list of all elements in a scene that belong to a given classname.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ addElement()

void addElement ( Element  element)
protected

Add element to list. Use in derived classes to add elements that your search found to be matching.

Parameters
elementElement to add

§ getClassname()

String getClassname ( )

Retrieves the classname to look for.

Returns
classname to look for

§ getElement()

Element getElement ( int  index)

Retrieves the indexed element.

Parameters
indexIndex of element
Returns
indexed element

§ getElementCount()

int getElementCount ( )

Retrieves the number of elements found.

Returns
number of found elements

§ new()

FindByClassnameProcessor new ( String  className)

Creates a new FindByClassnameProcessor object.

Parameters
classNameClassname to look for

§ processElement()

bool processElement ( Element  element)

Processes an element. Return true if you want to process more elements of false to stop.

Parameters
elementElement to process
Returns
true to continue processing elements or false to stop

Implements ElementProcessor.


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