Castor3D::Pattern< T > Class Template Reference

Pattern handler class. More...

Public Member Functions
	Pattern ()
	Constructor. More...
	~Pattern ()
	Destructor. More...
Pointer	GetReversed () const
	Builds the mirror pattern. More...
bool	IsClosed () const
	Tells if the pattern is closed (first element is also the last) More...
void	AddElement (TObjConstRef p_tElement, uint32_t p_index=0xFFFFFFFF)
	Adds an element to the list, at a given index. More...
uint32_t	GetSize () const
TObjRef	operator[] (uint32_t p_index)
	Accessor to an element. More...
TObjConstRef	operator[] (uint32_t p_index) const
	Constant accessor to an element. More...
TObjRef	GetElement (uint32_t p_index)
	Accessor to an element. More...
TObjConstRef	GetElement (uint32_t p_index) const
	Constant accessor to an element. More...

Detailed Description

template<typename T>
class Castor3D::Pattern< T >

Pattern handler class.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarks

A pattern is a collection of consecutive points

Constructor & Destructor Documentation

Pattern()

template<typename T >

Castor3D::Pattern< T >::Pattern ( )

inline

Constructor.

~Pattern()

template<typename T >

Castor3D::Pattern< T >::~Pattern ( )

inline

Destructor.

Member Function Documentation

AddElement()

template<typename T >

void Castor3D::Pattern< T >::AddElement ( TObjConstRef  p_tElement, uint32_t  p_index = 0xFFFFFFFF  )

inline

Adds an element to the list, at a given index.

Parameters

[in]	p_tElement	The element to add
[in]	p_index	The index at which the insertion must be done

GetElement() [1/2]

template<typename T >

TObjRef Castor3D::Pattern< T >::GetElement ( uint32_t  p_index )

inline

Accessor to an element.

Parameters

[in]

p_index

the index of the wanted element

Returns

Modifiable element

GetElement() [2/2]

template<typename T >

TObjConstRef Castor3D::Pattern< T >::GetElement ( uint32_t  p_index ) const

inline

Constant accessor to an element.

Parameters

[in]

p_index

the index of the wanted element

Returns

Constant element

GetReversed()

template<typename T >

Pointer Castor3D::Pattern< T >::GetReversed ( ) const

inline

Builds the mirror pattern.

Returns

The built pattern

GetSize()

template<typename T >

uint32_t Castor3D::Pattern< T >::GetSize ( ) const

inline

Returns

The number of elements constituting the pattern

IsClosed()

template<typename T >

bool Castor3D::Pattern< T >::IsClosed ( ) const

inline

Tells if the pattern is closed (first element is also the last)

Returns

true if closed, false if not

operator[]() [1/2]

template<typename T >

TObjRef Castor3D::Pattern< T >::operator[] ( uint32_t  p_index )

inline

Accessor to an element.

Parameters

[in]

p_index

the index of the wanted element

Returns

Modifiable element reference

operator[]() [2/2]

template<typename T >

TObjConstRef Castor3D::Pattern< T >::operator[] ( uint32_t  p_index ) const

inline

Constant accessor to an element.

Parameters

[in]

p_index

the index of the wanted element

Returns

Constant element reference

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Castor3DPrerequisites_Geometry.hpp
• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Pattern.hpp