castor3d::Pattern< T > Class Template Reference

Pattern handler class. More...

#include <Pattern.hpp>

Inheritance diagram for castor3d::Pattern< T >:

Public Member Functions
	Pattern ()=default
	Constructor. More...
Pattern< T >	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 element, uint32_t index=0xFFFFFFFF)
	adds an element to the list, at a given index More...
uint32_t	getSize () const
TObjRef	operator[] (uint32_t index)
	Accessor to an element. More...
TObjConstRef	operator[] (uint32_t index) const
	Constant accessor to an element. More...
TObjRef	getElement (uint32_t index)
	Accessor to an element. More...
TObjConstRef	getElement (uint32_t index) const
	Constant accessor to an element. More...

Detailed Description

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

Pattern handler class.

Remarks

A pattern is a collection of consecutive points.

Constructor & Destructor Documentation

Pattern()

template<typename T >

castor3d::Pattern< T >::Pattern ( )

default

Constructor.

Member Function Documentation

addElement()

template<typename T >

void castor3d::Pattern< T >::addElement ( TObjConstRef  element, uint32_t  index = 0xFFFFFFFF  )

inline

adds an element to the list, at a given index

Parameters

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

getElement() [1/2]

template<typename T >

TObjRef castor3d::Pattern< T >::getElement ( uint32_t  index )

inline

Accessor to an element.

Parameters

[in]

index

the index of the wanted element

Returns

Modifiable element

getElement() [2/2]

template<typename T >

TObjConstRef castor3d::Pattern< T >::getElement ( uint32_t  index ) const

inline

Constant accessor to an element.

Parameters

[in]

index

the index of the wanted element

Returns

Constant element

getReversed()

template<typename T >

Pattern< T > 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  index )

inline

Accessor to an element.

Parameters

[in]

index

the index of the wanted element

Returns

Modifiable element reference

operator[]() [2/2]

template<typename T >

TObjConstRef castor3d::Pattern< T >::operator[] ( uint32_t  index ) const

inline

Constant accessor to an element.

Parameters

[in]

index

the index of the wanted element

Returns

Constant element reference

---

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

• Miscellaneous/MiscellaneousModule.hpp
• Miscellaneous/Pattern.hpp