OMPF::OMPF Class Reference

#include <ompf.h>

Public Member Functions

 OMPF ()
 
 ~OMPF ()
 
void reset ()
 
void saveFile (iaString filename)
 
void loadFile (iaString filename)
 
ompfHeaderChunkgetRoot ()
 
ompfGroupChunkcreateGroupChunk ()
 
ompfTransformChunkcreateTransformChunk ()
 
ompfMaterialReferenceChunkcreateMaterialReferenceChunk ()
 
ompfMeshChunkcreateMeshChunk ()
 
ompfEmitterChunkcreateEmitterChunk ()
 
ompfParticleSystemChunkcreateParticleSystemChunk ()
 
ompfExternalReferenceChunkcreateExternalReferenceChunk ()
 
const std::vector< ompfMaterialReferenceChunk * > & getMaterialReferenceChunks () const
 
const iaStringgetFileDirectory () const
 

Detailed Description

this is the OMPF file format reference implementation

Constructor & Destructor Documentation

◆ OMPF()

OMPF::OMPF::OMPF ( )

initializes member variables

◆ ~OMPF()

OMPF::OMPF::~OMPF ( )

clears all referenced data

Member Function Documentation

◆ createEmitterChunk()

ompfEmitterChunk * OMPF::OMPF::createEmitterChunk ( )

creates a emitter chunk

Returns
pointer to emitter chunk

◆ createExternalReferenceChunk()

ompfExternalReferenceChunk * OMPF::OMPF::createExternalReferenceChunk ( )

creates a external reference chunk

Returns
pointer to new external reference chunk

◆ createGroupChunk()

ompfGroupChunk * OMPF::OMPF::createGroupChunk ( )

creates a group chunk

Returns
pointer to new group chunk

◆ createMaterialReferenceChunk()

ompfMaterialReferenceChunk * OMPF::OMPF::createMaterialReferenceChunk ( )

creates a material reference chunk

Returns
pointer to material chunk

◆ createMeshChunk()

ompfMeshChunk * OMPF::OMPF::createMeshChunk ( )

creates a mesh chunk

Returns
pointer to new mesh chunk

◆ createParticleSystemChunk()

ompfParticleSystemChunk * OMPF::OMPF::createParticleSystemChunk ( )

creates particle system chunk

Returns
pointer to particle system chunk

◆ createTransformChunk()

ompfTransformChunk * OMPF::OMPF::createTransformChunk ( )

creates a transform chunk

Returns
pointer to new transform chunk

◆ getFileDirectory()

const iaString & OMPF::OMPF::getFileDirectory ( ) const
Returns
the directory of the file we want to load or save

e.g. if the file path is c:\foo\bar.ompf then the return value will be c:\foo

the return string can be empty if load or save is not in process yet

◆ getMaterialReferenceChunks()

const std::vector< ompfMaterialReferenceChunk * > & OMPF::OMPF::getMaterialReferenceChunks ( ) const
Returns
list of material references

◆ getRoot()

ompfHeaderChunk * OMPF::OMPF::getRoot ( )
Returns
the root node of currently loaded data

is never zero

◆ loadFile()

void OMPF::OMPF::loadFile ( iaString  filename)

load data from file

Parameters
filenamethe source file name

◆ reset()

void OMPF::OMPF::reset ( )

reinitializes member variables

◆ saveFile()

void OMPF::OMPF::saveFile ( iaString  filename)

export data in to file

Parameters
filenamethe destination file name

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