Assimp v3.1.1 (June 2014)
Assimp::SharedPostProcessInfo Class Reference

Helper class to allow post-processing steps to interact with each other. More...

#include <BaseProcess.h>

Classes

struct  Base
 
struct  THeapData
 Represents data that is allocated on the heap, thus needs to be deleted. More...
 
struct  TStaticData
 Represents static, by-value data not allocated on the heap. More...
 

Public Types

typedef unsigned int KeyType
 
typedef std::map< KeyType, Base * > PropertyMap
 

Public Member Functions

template<typename T >
void AddProperty (const char *name, T *in)
 Add a heap property to the list. More...
 
template<typename T >
void AddProperty (const char *name, T in)
 Add a static by-value property to the list. More...
 
void Clean ()
 Remove all stored properties from the table. More...
 
template<typename T >
bool GetProperty (const char *name, T &out) const
 Get a static, by-value property. More...
 
template<typename T >
bool GetProperty (const char *name, T *&out) const
 Get a heap property. More...
 
void RemoveProperty (const char *name)
 Remove a property of a specific type. More...
 
 ~SharedPostProcessInfo ()
 Destructor. More...
 

Detailed Description

Helper class to allow post-processing steps to interact with each other.

The class maintains a simple property list that can be used by pp-steps to provide additional information to other steps. This is primarily intended for cross-step optimizations.

Member Typedef Documentation

◆ KeyType

◆ PropertyMap

Constructor & Destructor Documentation

◆ ~SharedPostProcessInfo()

Assimp::SharedPostProcessInfo::~SharedPostProcessInfo ( )
inline

Destructor.

Member Function Documentation

◆ AddProperty() [1/2]

template<typename T >
void Assimp::SharedPostProcessInfo::AddProperty ( const char *  name,
T *  in 
)
inline

Add a heap property to the list.

◆ AddProperty() [2/2]

template<typename T >
void Assimp::SharedPostProcessInfo::AddProperty ( const char *  name,
in 
)
inline

Add a static by-value property to the list.

◆ Clean()

void Assimp::SharedPostProcessInfo::Clean ( )
inline

Remove all stored properties from the table.

◆ GetProperty() [1/2]

template<typename T >
bool Assimp::SharedPostProcessInfo::GetProperty ( const char *  name,
T &  out 
) const
inline

Get a static, by-value property.

◆ GetProperty() [2/2]

template<typename T >
bool Assimp::SharedPostProcessInfo::GetProperty ( const char *  name,
T *&  out 
) const
inline

Get a heap property.

◆ RemoveProperty()

void Assimp::SharedPostProcessInfo::RemoveProperty ( const char *  name)
inline

Remove a property of a specific type.


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