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 GeometrySource &	front ()
	Get the first element of the hierarchy.
CORE_FORCE_INLINE GeometrySource &	back ()
	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 GeometrySource &	operator[] (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]

i

the 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]

i

the 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]

element

the 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]	index	the 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]	module	the pointer to the scene object

CORE_FORCE_INLINE void GeometrySourceHierarchy::set_count

(

const unsigned int &

count

)

Set the size of the hierarchy.

Parameters

[in]

count

the number of elements needed in the hierarchy