C++ class MinSG::SceneManagement::ImportContext
ImportContext

public

Inheritance Graph

graph BT
	ImportContext
	ImportContext --> AttributeProvider
	click ImportContext "classMinSG_1_1SceneManagement_1_1ImportContext"
	click AttributeProvider "classUtil_1_1AttributeProvider"

Description

Helper structure that keeps data for one import process.

Registered Textures

typedef std::map< const std::string, Util::Reference < Rendering::Texture > >	textureRegistry_t
textureRegistry_t &	getTextureRegistry()

Registered Meshes (with filenames)

typedef std::map< const std::string, Util::Reference < Rendering::Mesh > >	meshRegistry_t
meshRegistry_t &	getMeshRegistry()
void	registerMesh(const std::string & fileName, Rendering::Mesh * t)
void	unregisterMesh(const std::string & fileName)
Rendering::Mesh *	getRegisteredMesh(const std::string & fileName) const

Registered Meshes (with hashing)

typedef std::vector< Util::Reference < Rendering::Mesh > >	meshHashingRegistryBucket_t
typedef std::map< uint32_t, meshHashingRegistryBucket_t >	meshHasingRegistry_t
void	registerMesh(const uint32_t hash, Rendering::Mesh * m)
Rendering::Mesh *	getRegisteredMesh(const uint32_t hash, Rendering::Mesh * m) const

Public Types

typedef std::function< void( ImportContext &)>	FinalizeAction A function that allows the execution of arbitrary actions at the end of the import process.

Public Attributes

SceneManager &	sceneManager
GroupNode *	rootNode
uint32_t	importOptions
Util::FileName	fileName
Util::FileLocator	fileLocator
std::deque< FinalizeAction >	finalizeActions

Public Functions

	ImportContext( SceneManager & _m, GroupNode * _rootNode, uint32_t _f, Util::FileName path)
void	addFinalizingAction(const FinalizeAction & action)
void	addSearchPath(std::string p)
void	executeFinalizingActions()
uint32_t	getImportOptions() const
const Util::FileName &	getFileName() const
GroupNode *	getRootNode() const
void	setFileName(const Util::FileName & f)
void	setRootNode( GroupNode * n)

---

Documentation

typedef
MinSG::SceneManagement::ImportContext::textureRegistry_t

public

typedef std::map< const std::string, Util::Reference < Rendering::Texture > > textureRegistry_t

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:68}

---

function
MinSG::SceneManagement::ImportContext::getTextureRegistry

public

inline

textureRegistry_t & getTextureRegistry(	)

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:69}

---

typedef
MinSG::SceneManagement::ImportContext::meshRegistry_t

public

typedef std::map< const std::string, Util::Reference < Rendering::Mesh > > meshRegistry_t

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:92}

---

function
MinSG::SceneManagement::ImportContext::getMeshRegistry

public

inline

meshRegistry_t & getMeshRegistry(	)

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:93}

---

function
MinSG::SceneManagement::ImportContext::registerMesh

public

void registerMesh(	const std::string &	fileName,
	Rendering::Mesh *	t
)

Associates a Mesh with a name.

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:96}

---

function
MinSG::SceneManagement::ImportContext::unregisterMesh

public

void unregisterMesh(	const std::string &	fileName )

The association of a Mesh with a given name is removed.

Parameters

name

A registered name.

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:100}

---

function
MinSG::SceneManagement::ImportContext::getRegisteredMesh

public

const

Rendering::Mesh * getRegisteredMesh(	const std::string &	fileName ) const

Returns the Mesh registered to a name.

Parameters

name

The registered name.

Returns

The registered Mesh or nullptr.

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:105}

---

typedef
MinSG::SceneManagement::ImportContext::meshHashingRegistryBucket_t

public

typedef std::vector< Util::Reference < Rendering::Mesh > > meshHashingRegistryBucket_t

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:116}

---

typedef
MinSG::SceneManagement::ImportContext::meshHasingRegistry_t

public

typedef std::map< uint32_t, meshHashingRegistryBucket_t > meshHasingRegistry_t

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:117}

---

function
MinSG::SceneManagement::ImportContext::registerMesh

public

inline

void registerMesh(	const uint32_t	hash,
	Rendering::Mesh *	m
)

Associates a Mesh with a hash value.

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:120}

---

function
MinSG::SceneManagement::ImportContext::getRegisteredMesh

public

const

Rendering::Mesh * getRegisteredMesh(	const uint32_t	hash,
	Rendering::Mesh *	m
) const

Returns a Mesh with the same data as the given mesh and hash-value

Parameters

hash

The hash of the mesh.

mesh

The Mesh for comparison.

Returns

The registered Mesh or nullptr.

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:127}

---

typedef
MinSG::SceneManagement::ImportContext::FinalizeAction

public

typedef std::function< void( ImportContext &)> FinalizeAction

A function that allows the execution of arbitrary actions at the end of the import process.

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:42}

---

variable
MinSG::SceneManagement::ImportContext::sceneManager

public

SceneManager & sceneManager

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:35}

---

variable
MinSG::SceneManagement::ImportContext::rootNode

public

GroupNode * rootNode

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:36}

---

variable
MinSG::SceneManagement::ImportContext::importOptions

public

uint32_t importOptions

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:37}

---

variable
MinSG::SceneManagement::ImportContext::fileName

public

Util::FileName fileName

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:38}

---

variable
MinSG::SceneManagement::ImportContext::fileLocator

public

Util::FileLocator fileLocator

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:39}

---

variable
MinSG::SceneManagement::ImportContext::finalizeActions

public

std::deque< FinalizeAction > finalizeActions

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:43}

---

function
MinSG::SceneManagement::ImportContext::ImportContext

public

inline

ImportContext(	SceneManager &	_m,
	GroupNode *	_rootNode,
	uint32_t	_f,
	Util::FileName	path
)

(ctor)

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:46}

---

function
MinSG::SceneManagement::ImportContext::addFinalizingAction

public

inline

void addFinalizingAction(	const FinalizeAction &	action )

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:50}

---

function
MinSG::SceneManagement::ImportContext::addSearchPath

public

inline

void addSearchPath(	std::string	p )

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:51}

---

function
MinSG::SceneManagement::ImportContext::executeFinalizingActions

public

void executeFinalizingActions(	)

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:53}

---

function
MinSG::SceneManagement::ImportContext::getImportOptions

public

const

inline

uint32_t getImportOptions(	) const

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:54}

---

function
MinSG::SceneManagement::ImportContext::getFileName

public

const

inline

const Util::FileName & getFileName(	) const

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:55}

---

function
MinSG::SceneManagement::ImportContext::getRootNode

public

const

inline

GroupNode * getRootNode(	) const

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:56}

---

function
MinSG::SceneManagement::ImportContext::setFileName

public

inline

void setFileName(	const Util::FileName &	f )

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:58}

---

function
MinSG::SceneManagement::ImportContext::setRootNode

public

inline

void setRootNode(	GroupNode *	n )

_{Defined in MinSG/SceneManagement/Importer/ImportContext.h:59}

---