Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
GeometrySourceHierarchy Class Reference

Class that contains the hierarchy of scene objects from which a geometry is accessed. More...

Public Member Functions

CORE_FORCE_INLINE GeometrySourceHierarchy (const GeometrySourceHierarchy &other)
 
CORE_FORCE_INLINE bool is_empty () const
 Tell if the hierarchy is empty.
 
CORE_FORCE_INLINE const
unsigned int & 
get_count () const
 Get the size of the hierarchy.
 
CORE_FORCE_INLINE void empty ()
 Remove all the elements from the hierarchy.
 
CORE_FORCE_INLINE void set_count (const unsigned int &count)
 Set the size of the hierarchy.
 
CORE_FORCE_INLINE void push (const GeometrySource &element)
 Add a new element at the end of the hierarchy.
 
CORE_FORCE_INLINE void push (const unsigned int &index, ModuleSceneObject *module, GeometryOverride *override=0)
 Add a new element at the end of the hierarchy.
 
CORE_FORCE_INLINE void pop ()
 Remove the element at the end of the hierarchy.
 
CORE_FORCE_INLINE const
GeometrySource
front () const
 Get the first element of the hierarchy.
 
CORE_FORCE_INLINE const
GeometrySource
back () const
 Get the last element of the hierarchy.
 
CORE_FORCE_INLINE GeometrySourcefront ()
 Get the first element of the hierarchy.
 
CORE_FORCE_INLINE GeometrySourceback ()
 Get the last element of the hierarchy.
 
CORE_FORCE_INLINE const
GeometrySource
operator[] (const unsigned int &i) const
 Get the ith element of the hierarchy.
 
CORE_FORCE_INLINE GeometrySourceoperator[] (const unsigned int &i)
 Get the ith element of the hierarchy.
 
CORE_FORCE_INLINE
GeometrySourceHierarchy
operator= (const GeometrySourceHierarchy &other)
 

Detailed Description

Class that contains the hierarchy of scene objects from which a geometry is accessed.

Member Function Documentation

CORE_FORCE_INLINE const GeometrySource& GeometrySourceHierarchy::back ( ) const

Get the last element of the hierarchy.

Returns
a constant reference to the element
CORE_FORCE_INLINE GeometrySource& GeometrySourceHierarchy::back ( )

Get the last element of the hierarchy.

Returns
a reference to the element
CORE_FORCE_INLINE const GeometrySource& GeometrySourceHierarchy::front ( ) const

Get the first element of the hierarchy.

Returns
a constant reference to the element
CORE_FORCE_INLINE GeometrySource& GeometrySourceHierarchy::front ( )

Get the first element of the hierarchy.

Returns
a reference to the element
CORE_FORCE_INLINE const unsigned int& GeometrySourceHierarchy::get_count ( ) const

Get the size of the hierarchy.

Returns
the number of elements in the hierarchy
CORE_FORCE_INLINE bool GeometrySourceHierarchy::is_empty ( ) const

Tell if the hierarchy is empty.

Returns
true if it's empty, else false
CORE_FORCE_INLINE const GeometrySource& GeometrySourceHierarchy::operator[] ( const unsigned int &  i) const

Get the ith element of the hierarchy.

Parameters
[in]ithe index of the element to get
Returns
a constant reference to the element
CORE_FORCE_INLINE GeometrySource& GeometrySourceHierarchy::operator[] ( const unsigned int &  i)

Get the ith element of the hierarchy.

Parameters
[in]ithe index of the element to get
Returns
a reference to the element
CORE_FORCE_INLINE void GeometrySourceHierarchy::push ( const GeometrySource element)

Add a new element at the end of the hierarchy.

Parameters
[in]elementthe element to push
CORE_FORCE_INLINE void GeometrySourceHierarchy::push ( const unsigned int &  index,
ModuleSceneObject module,
GeometryOverride override = 0 
)

Add a new element at the end of the hierarchy.

Parameters
[in]indexthe index of scene object in the scene (if the hierarchy is empty) or in regard to its parent (the last element in the hierarchy)
[in]modulethe pointer to the scene object
CORE_FORCE_INLINE void GeometrySourceHierarchy::set_count ( const unsigned int &  count)

Set the size of the hierarchy.

Parameters
[in]countthe number of elements needed in the hierarchy