This class unifies all references to the same filename, so that multiple attempts to load the same model will return the same pointer. More...

#include "modelPool.h"

Static Public Member Functions
static void	add_model (const Filename &filename, ModelRoot *model)
	Adds the indicated already-loaded model to the pool. More...

static void	add_model (ModelRoot *model)
	Adds the indicated already-loaded model to the pool. More...

static int	garbage_collect ()
	Releases only those models in the pool that have a reference count of exactly 1; i.e. More...

static ModelRoot *	get_model (const Filename &filename, bool verify)
	Returns the model that has already been previously loaded, or NULL otherwise. More...

static bool	has_model (const Filename &filename)
	Returns true if the model has ever been loaded, false otherwise. More...

static void	list_contents (std::ostream &out)
	Lists the contents of the model pool to the indicated output stream. More...

static void	list_contents ()
	Lists the contents of the model pool to cout. More...

static ModelRoot *	load_model (const Filename &filename, const LoaderOptions &options=LoaderOptions())
	Loads the given filename up as a model, if it has not already been loaded, and returns the new model. More...

static void	release_all_models ()
	Releases all models in the pool and restores the pool to the empty state. More...

static void	release_model (const Filename &filename)
	Removes the indicated model from the pool, indicating it will never be loaded again; the model may then be freed. More...

static void	release_model (ModelRoot *model)
	Removes the indicated model from the pool, indicating it will never be loaded again; the model may then be freed. More...

static bool	verify_model (const Filename &filename)
	Loads the given filename up as a model, if it has not already been loaded, and returns true to indicate success, or false to indicate failure. More...

static void	write (std::ostream &out)
	Lists the contents of the model pool to the indicated output stream. More...

Detailed Description

This class unifies all references to the same filename, so that multiple attempts to load the same model will return the same pointer.

Note that the default behavior is thus to make instances: use with caution. Use the copy_subgraph() method on Node (or use NodePath::copy_to) to make modifiable copies of the node.

Unlike TexturePool, this class does not automatically resolve the model filenames before loading, so a relative path and an absolute path to the same model will appear to be different filenames.

However, see the Loader class, which is now the preferred interface for loading models. The Loader class can resolve filenames, supports threaded loading, and can automatically consult the ModelPool, according to the supplied LoaderOptions.

Definition at line 42 of file modelPool.h.

Member Function Documentation

◆ add_model() [1/2]

void ModelPool::add_model	(	const Filename &	filename,
		ModelRoot *	model
	)

inlinestatic

Adds the indicated already-loaded model to the pool.

The model will replace any previously-loaded model in the pool that had the same filename.

This two-parameter version of this method is deprecated; use the one- parameter add_model(model) instead.

Definition at line 70 of file modelPool.I.

◆ add_model() [2/2]

void ModelPool::add_model ( ModelRoot * model )

inlinestatic

Adds the indicated already-loaded model to the pool.

The model will replace any previously-loaded model in the pool that had the same filename.

Definition at line 93 of file modelPool.I.

◆ garbage_collect()

int ModelPool::garbage_collect ( )

inlinestatic

Releases only those models in the pool that have a reference count of exactly 1; i.e.

only those models that are not being used outside of the pool. Returns the number of models released.

Definition at line 125 of file modelPool.I.

◆ get_model()

ModelRoot * ModelPool::get_model	(	const Filename &	filename,
		bool	verify
	)

inlinestatic

Returns the model that has already been previously loaded, or NULL otherwise.

If verify is true, it will check if the file is still up-to- date (and hasn't been modified in the meantime), and if not, will still return NULL.

Definition at line 46 of file modelPool.I.

◆ has_model()

bool ModelPool::has_model ( const Filename & filename )

inlinestatic

Returns true if the model has ever been loaded, false otherwise.

Note that this does not guarantee that the model is still up-to-date.

Definition at line 19 of file modelPool.I.

◆ list_contents() [1/2]

void ModelPool::list_contents ( std::ostream & out )

inlinestatic

Lists the contents of the model pool to the indicated output stream.

Definition at line 133 of file modelPool.I.

◆ list_contents() [2/2]

void ModelPool::list_contents ( )

inlinestatic

Lists the contents of the model pool to cout.

Definition at line 141 of file modelPool.I.

◆ load_model()

ModelRoot * ModelPool::load_model	(	const Filename &	filename,
		const LoaderOptions &	options = `LoaderOptions()`
	)

inlinestatic

Loads the given filename up as a model, if it has not already been loaded, and returns the new model.

If a model with the same filename was previously loaded, returns that one instead (unless cache-check-timestamps is true and the file has recently changed). If the model file cannot be found, or cannot be loaded for some reason, returns NULL.

Definition at line 58 of file modelPool.I.

Referenced by verify_model().

◆ release_all_models()

void ModelPool::release_all_models ( )

inlinestatic

Releases all models in the pool and restores the pool to the empty state.

Definition at line 115 of file modelPool.I.

◆ release_model() [1/2]

void ModelPool::release_model ( const Filename & filename )

inlinestatic

Removes the indicated model from the pool, indicating it will never be loaded again; the model may then be freed.

If this function is never called, a reference count will be maintained on every model every loaded, and models will never be freed.

This version of this method is deprecated; use release_model(model) instead.

Definition at line 84 of file modelPool.I.

◆ release_model() [2/2]

void ModelPool::release_model ( ModelRoot * model )

inlinestatic

Removes the indicated model from the pool, indicating it will never be loaded again; the model may then be freed.

If this function (and garbage_collect()) is never called, a reference count will be maintained on every model every loaded, and models will never be freed.

The model's get_fullpath() value should not have been changed during its lifetime, or this function may fail to locate it in the pool.

Definition at line 107 of file modelPool.I.

◆ verify_model()

bool ModelPool::verify_model ( const Filename & filename )

inlinestatic

Loads the given filename up as a model, if it has not already been loaded, and returns true to indicate success, or false to indicate failure.

If this returns true, it is probable that a subsequent call to load_model() with the same model name will return a valid PandaNode.

However, even if this returns true, it is still possible for a subsequent call to load_model() to fail. This can happen if cache-check-timestamps is true, and the on-disk file is subsequently modified to replace it with an invalid model.

Definition at line 35 of file modelPool.I.

References load_model().

◆ write()

void ModelPool::write ( std::ostream & out )

static

Lists the contents of the model pool to the indicated output stream.

Helps with debugging.

Definition at line 28 of file modelPool.cxx.

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

panda/src/pgraph/modelPool.h
panda/src/pgraph/modelPool.cxx
panda/src/pgraph/modelPool.I

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ add_model() [1/2]

◆ add_model() [2/2]

◆ garbage_collect()

◆ get_model()

◆ has_model()

◆ list_contents() [1/2]

◆ list_contents() [2/2]

◆ load_model()

◆ release_all_models()

◆ release_model() [1/2]

◆ release_model() [2/2]

◆ verify_model()

◆ write()