This is the documentation for Enlighten.

class Enlighten MaterialComponentBuffer

template<typename Colour>
class Enlighten::MaterialComponentBuffer

MaterialComponentBuffer type interface.

Typedefs

Name Description
GenericColourBuffer< ColourType > BaseType

Concrete type of the base class.

Colour ColourType

Colour type stored in this buffer.

C ColourType

Colour type.

BaseType::ConstIteratorType ConstIteratorType

ConstIterator type.

ConstIterator< ColourType > ConstIteratorType

Const Iterator type.

BaseType::IteratorType IteratorType

Iterator type.

Iterator< ColourType > IteratorType

Iterator type.

Functions

Name Description
Begin()

Return a const iterator at the beginning of this buffer.

Begin()

Return an iterator at the beginning of this buffer.

Begin()

Returns an iterator to the first value in the buffer.

Begin()

Returns a const iterator to the first value in the buffer.

ByteSwapMembers()

Endian swap the members of the header.

ByteSwapPayload(Geo::EConvertEndianMode)

Endian swap the buffer contents.

CalculateBufferSize(Geo::s32)

Returns the size of the buffer in bytes.

CalculateBufferSize(const InputWorkspace *)

Calculate the size of the buffer for a given InputWorkspace.

Clear()

Reset the contents of this buffer to zero/black.

Clear()

Reset the contents of this buffer to zero/black.

ConvertEndian(Geo::EConvertEndianMode)

Endian swap the buffer.

ConvertEndian(Geo::EConvertEndianMode)

Endian swap the buffer.

Copy(const GenericColourBuffer< ColourType > &)

Copy values from another buffer.

Copy(const MaterialComponentBuffer &)

Copy values from another buffer.

Create(const InputWorkspace *, void *)

Create a buffer for a given workspace in the supplied memory.

Create(const MaterialComponentBuffer &, void *)

Create a duplicated buffer from the source, in the supplied memory.

Create(Geo::GeoGuid, Geo::s32, void *)

Creates a buffer in memory.

Create(void *, const GenericColourBuffer &)

Creates a copy in memory.

End()

Returns a const iterator to the last+1 value in the buffer.

End()

Return an iterator at the end of this buffer.

End()

Return a const iterator at the end of this buffer.

End()

Returns an iterator to the last+1 value in the buffer.

GenericColourBuffer(Geo::GeoGuid, Geo::s32, Geo::s32)

Main constructor.

GenericColourBuffer(const GenericColourBuffer &)

Copy constructor.

GetNumValues()

Returns the number of values in this buffer.

GetNumValues()

Returns the number of values in this buffer.

GetSize()

Returns the size of this buffer in bytes.

GetSize()

Returns the size of this buffer in bytes.

GetSystemId()

Returns the guid of the system that this buffer correlates to.

GetSystemId()

Returns the guid of the system that this buffer correlates to.

Variables

Name Description
Geo::u32 m_NumValues

Number of clusters.

Geo::GeoGuid m_ObjectId

Id of the system/cube map that these lighting values apply to.

Geo::u32 m_Padding[2]

Unused padding. Explicitly declared so can be zero-initialised.

Geo::s32 m_PayloadOffset

Byte offset from beginning of the header to the colour data.


ConstIteratorType Enlighten::GenericColourBuffer< C >::Begin


public: ConstIteratorType Begin() const


Return a const iterator at the beginning of this buffer.


IteratorType Enlighten::GenericColourBuffer< C >::Begin


public: IteratorType Begin()


Return an iterator at the beginning of this buffer.


IteratorType Enlighten::MaterialComponentBuffer< Colour >::Begin


public: IteratorType Begin()


Returns an iterator to the first value in the buffer.


ConstIteratorType Enlighten::MaterialComponentBuffer< Colour >::Begin


public: ConstIteratorType Begin() const


Returns a const iterator to the first value in the buffer.


void Enlighten::GenericColourBuffer< ColourType >::ByteSwapMembers


protected: void ByteSwapMembers()


Endian swap the members of the header.


void Enlighten::GenericColourBuffer< ColourType >::ByteSwapPayload


protected: void ByteSwapPayload
(
    Geo::EConvertEndianMode mode
)


Endian swap the buffer contents.


Geo::u32 Enlighten::GenericColourBuffer< ColourType >::CalculateBufferSize


public: Geo::u32 CalculateBufferSize
(
    Geo::s32 numValues
)


Returns the size of the buffer in bytes.


static Geo::u32 Enlighten::MaterialComponentBuffer< Colour >::CalculateBufferSize


public: Geo::u32 CalculateBufferSize
(
    const InputWorkspace * inputWorkspace
)


Calculate the size of the buffer for a given InputWorkspace.


void Enlighten::GenericColourBuffer< ColourType >::Clear


public: void Clear()


Reset the contents of this buffer to zero/black.


void Enlighten::MaterialComponentBuffer< Colour >::Clear


public: void Clear()


Reset the contents of this buffer to zero/black.


void Enlighten::GenericColourBuffer< ColourType >::ConvertEndian


public: void ConvertEndian
(
    Geo::EConvertEndianMode mode
)


Endian swap the buffer.


void Enlighten::MaterialComponentBuffer< Colour >::ConvertEndian


public: void ConvertEndian
(
    Geo::EConvertEndianMode mode
)


Endian swap the buffer.


bool Enlighten::GenericColourBuffer< ColourType >::Copy


public: bool Copy
(
    const GenericColourBuffer< ColourType > & source
)


Copy values from another buffer.


bool Enlighten::MaterialComponentBuffer< Colour >::Copy


public: bool Copy
(
    const MaterialComponentBuffer & source
)


Copy values from another buffer.


static MaterialComponentBuffer* Enlighten::MaterialComponentBuffer< Colour >::Create


public: MaterialComponentBuffer * Create
(
    const InputWorkspace * inputWorkspace,
    void * memory
)


Create a buffer for a given workspace in the supplied memory.


static MaterialComponentBuffer* Enlighten::MaterialComponentBuffer< Colour >::Create


public: MaterialComponentBuffer * Create
(
    const MaterialComponentBuffer & source,
    void * memory
)


Create a duplicated buffer from the source, in the supplied memory.


GenericColourBuffer< ColourType > * Enlighten::GenericColourBuffer< ColourType >::Create


public: GenericColourBuffer * Create
(
    Geo::GeoGuid objectId,
    Geo::s32 numValues,
    void * memory
)


Creates a buffer in memory.


GenericColourBuffer< ColourType > * Enlighten::GenericColourBuffer< ColourType >::Create


public: GenericColourBuffer * Create
(
    void * memory,
    const GenericColourBuffer & source
)


Creates a copy in memory.


ConstIteratorType Enlighten::MaterialComponentBuffer< Colour >::End


public: ConstIteratorType End() const


Returns a const iterator to the last+1 value in the buffer.


IteratorType Enlighten::GenericColourBuffer< C >::End


public: IteratorType End()


Return an iterator at the end of this buffer.


ConstIteratorType Enlighten::GenericColourBuffer< C >::End


public: ConstIteratorType End() const


Return a const iterator at the end of this buffer.


IteratorType Enlighten::MaterialComponentBuffer< Colour >::End


public: IteratorType End()


Returns an iterator to the last+1 value in the buffer.


Enlighten::GenericColourBuffer< ColourType >::GenericColourBuffer


protected: GenericColourBuffer
(
    Geo::GeoGuid objectId,
    Geo::s32 numValues,
    Geo::s32 payloadOffset
)


Main constructor.


Enlighten::GenericColourBuffer< ColourType >::GenericColourBuffer


protected: GenericColourBuffer
(
    const GenericColourBuffer & source
)


Copy constructor.


Geo::u32 Enlighten::MaterialComponentBuffer< Colour >::GetNumValues


public: Geo::u32 GetNumValues() const


Returns the number of values in this buffer.


Geo::u32 Enlighten::GenericColourBuffer< C >::GetNumValues


public: Geo::u32 GetNumValues() const


Returns the number of values in this buffer.


size_t Enlighten::MaterialComponentBuffer< Colour >::GetSize


public: size_t GetSize() const


Returns the size of this buffer in bytes.


size_t Enlighten::GenericColourBuffer< C >::GetSize


public: size_t GetSize() const


Returns the size of this buffer in bytes.


Geo::GeoGuid Enlighten::MaterialComponentBuffer< Colour >::GetSystemId


public: Geo::GeoGuid GetSystemId() const


Returns the guid of the system that this buffer correlates to.


Geo::GeoGuid Enlighten::GenericColourBuffer< C >::GetSystemId


public: Geo::GeoGuid GetSystemId() const


Returns the guid of the system that this buffer correlates to.