OMPF::ompfBaseChunk Class Reference

#include <ompfBaseChunk.h>

Inherited by OMPF::ompfEmitterChunk, OMPF::ompfExternalReferenceChunk, OMPF::ompfGroupChunk, OMPF::ompfHeaderChunk, OMPF::ompfMaterialReferenceChunk, OMPF::ompfMeshChunk, OMPF::ompfParticleSystemChunk, OMPF::ompfResourceSearchPathChunk, and OMPF::ompfTransformChunk.

Public Member Functions
	ompfBaseChunk (OMPFChunkType typeID)
virtual	~ompfBaseChunk ()=default
virtual bool	write (std::ofstream &stream, const ompfSettings &settings)
virtual bool	read (std::ifstream &stream, ompfSettings &settings)
void	insertChunk (ompfBaseChunk *chunk)
void	removeChunk (ompfBaseChunk *chunk)
bool	hasParent () const
uint32	getParentID () const
void	setParentID (const uint32 parentID)
bool	hasChildren () const
const std::vector< ompfBaseChunk * > &	getChildren () const
void	setID (const uint32 chunkID)
uint32	getID () const
virtual uint32	getSize (const ompfSettings &settings)
OMPFChunkType	getType () const
void	setName (const iaString &name)
iaString	getName () const

Detailed Description

ompf base chunk. all chunks have to derive from this class

Constructor & Destructor Documentation

ompfBaseChunk()

OMPF::ompfBaseChunk::ompfBaseChunk

(

OMPFChunkType

typeID

)

ctor

~ompfBaseChunk()

virtual OMPF::ompfBaseChunk::~ompfBaseChunk ( )

virtualdefault

dtor does nothing

Member Function Documentation

getChildren()

const std::vector< ompfBaseChunk * > & OMPF::ompfBaseChunk::getChildren

(

)

const

Returns

list of children

getID()

uint32 OMPF::ompfBaseChunk::getID

(

)

const

Returns

chunk id

getName()

iaString OMPF::ompfBaseChunk::getName

(

)

const

Returns

name of chunk

getParentID()

uint32 OMPF::ompfBaseChunk::getParentID

(

)

const

Returns

parent chunk id. returns INVALID_CHUNK_ID if there is no parent

getSize()

uint32 OMPF::ompfBaseChunk::getSize ( const ompfSettings &  settings )

virtual

Returns

chunk size in bytes

size can differ for different settings

Parameters

settings

the settings to take in to account

Reimplemented in OMPF::ompfEmitterChunk, OMPF::ompfMeshChunk, OMPF::ompfExternalReferenceChunk, OMPF::ompfGroupChunk, OMPF::ompfHeaderChunk, OMPF::ompfMaterialReferenceChunk, OMPF::ompfParticleSystemChunk, OMPF::ompfResourceSearchPathChunk, and OMPF::ompfTransformChunk.

getType()

OMPFChunkType OMPF::ompfBaseChunk::getType

(

)

const

Returns

chunk type id

hasChildren()

bool OMPF::ompfBaseChunk::hasChildren

(

)

const

Returns

true if chunk has children

hasParent()

bool OMPF::ompfBaseChunk::hasParent

(

)

const

Returns

true if chunk has a parent chunk

insertChunk()

void OMPF::ompfBaseChunk::insertChunk

(

ompfBaseChunk *

chunk

)

insert chunk in chunk

Parameters

chunk

the child chunk to insert

read()

bool OMPF::ompfBaseChunk::read ( std::ifstream &  stream, ompfSettings &  settings  )

virtual

reads a chunk from stream

Parameters

stream	source stream
settings	the settings used to read the stream

Returns

true if there was no error

Reimplemented in OMPF::ompfHeaderChunk.

removeChunk()

void OMPF::ompfBaseChunk::removeChunk

(

ompfBaseChunk *

chunk

)

removes chunk from chunk

Parameters

chunk

the child chunk to remove

setID()

void OMPF::ompfBaseChunk::setID

(

const uint32

chunkID

)

sets chunk id

Parameters

chunkID

setName()

void OMPF::ompfBaseChunk::setName

(

const iaString &

name

)

sets name of chunk

Parameters

name	the name of the chunk

setParentID()

void OMPF::ompfBaseChunk::setParentID

(

const uint32

parentID

)

sets parent id

Parameters

parentID

the parents ID

write()

bool OMPF::ompfBaseChunk::write ( std::ofstream &  stream, const ompfSettings &  settings  )

virtual

writes current this cunk to specified stream

Parameters

stream	destination stream
settings	the settings used to write the ompf file

Returns

true if there was no error

Reimplemented in OMPF::ompfHeaderChunk.

---

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

• /home/maddin/dev/Igor/src/ompf/ompf/chunks/ompfBaseChunk.h
• /home/maddin/dev/Igor/src/ompf/ompf/chunks/ompfBaseChunk.cpp