From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNL3D_1_1CShapeBankUser.html | 508 ++++++++++++++++++++++ 1 file changed, 508 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CShapeBankUser.html (limited to 'docs/doxygen/nel/classNL3D_1_1CShapeBankUser.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CShapeBankUser.html b/docs/doxygen/nel/classNL3D_1_1CShapeBankUser.html new file mode 100644 index 00000000..4db3f55b --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CShapeBankUser.html @@ -0,0 +1,508 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NL3D::CShapeBankUser Class Reference

Implementation of the user interface managing shape bank. +More... +

+#include <shape_bank_user.h> +

Inheritance diagram for NL3D::CShapeBankUser: +

+ + + +List of all members. + + + + + + + + + + + + + + + + + + +

Public Methods
virtual	~CShapeBankUser ()
virtual void	addShapeCache (const std::string &shapeCacheName)
	Add a new ShapeCache. More...
virtual void	removeShapeCache (const std::string &shapeCacheName)
	Remove a ShapeCache. More...
virtual void	reset ()
	Remove all ShapeCache and suppress all links (even the link to the default cache are removed). More...
virtual void	setShapeCacheSize (const std::string &shapeCacheName, sint32 maxSize)
	Set the shapeCache shapeCacheName the new size.(delete shapes if maxsize<shapeCacheSize). More...
virtual void	linkShapeToShapeCache (const std::string &shapeName, const std::string &shapeCacheName)
	Link a shape to a ShapeCache. More...
virtual void	preLoadShapesFromDirectory (const std::string &shapeCacheName, const std::string &path, const std::string &wildCard, bool recurs)
	PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. More...
virtual void	preLoadShapesFromBNP (const std::string &shapeCacheName, const std::string &bnpName, const std::string &wildCard)
	PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. More...
Public Attributes
CShapeBank	_ShapeBank

Detailed Description

+Implementation of the user interface managing shape bank. +

+Author:: +Matthieu Besson , Nevrax France

+Date:: +2001

+ +

+Definition at line 45 of file shape_bank_user.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
virtual NL3D::CShapeBankUser::~CShapeBankUser ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 48 of file shape_bank_user.h. +
+References NL3D_MEM_SHAPE_BANK.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NL3D::CShapeBankUser::addShapeCache ( const std::string & shapeCacheName ) [virtual]
+
+ + + + + +
+ + + +
+Add a new ShapeCache. +
+If already exist do nothing. +
+Implements NL3D::UShapeBank. +
+Definition at line 41 of file shape_bank_user.cpp. +
+References _ShapeBank, and NL3D_MEM_SHAPE_BANK.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CShapeBankUser::linkShapeToShapeCache ( const std::string & shapeName,
const std::string & shapeCacheName
) [virtual]
+
+ + + + + +
+ + + +
+Link a shape to a ShapeCache. +
+The ShapeCache must exist and must not contains the shape. +
+Implements NL3D::UShapeBank. +
+Definition at line 73 of file shape_bank_user.cpp. +
+References _ShapeBank, and NL3D_MEM_SHAPE_BANK.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NL3D::CShapeBankUser::preLoadShapesFromBNP ( const std::string & shapeCacheName,
const std::string & bnpName,
const std::string & wildCard
) [virtual]
+
+ + + + + +
+ + + +
+PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. +
+same as preLoadShapesFromDirectory() but take a BNP name which must have been added with CBigFile::add() or through CPath::addSearchBigFile()
+Parameters:
+ + +
bnpName +eg: "characters.bnp" (NB: set the bigFileNAme without any path).
+
+
+Implements NL3D::UShapeBank. +
+Definition at line 93 of file shape_bank_user.cpp. +
+References _ShapeBank.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void NL3D::CShapeBankUser::preLoadShapesFromDirectory ( const std::string & shapeCacheName,
const std::string & path,
const std::string & wildCard,
bool recurs
) [virtual]
+
+ + + + + +
+ + + +
+PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. +
+Shapes are Loaded if not present, assigned to the given cache, and fit in the cache Size as max possible. NB: crash if you try to load a non shape file (eg: a .dds etc...)
+Parameters:
+ + + + + +
shapeCacheName +name of a shapeCache created with addShapeCache()/setShapeCacheSize(). no-op if don't exist
path +a valid path (local or not) where to find shapes. NB: CPath is used to load the shapes.
wildcard +a filter string like: "*.shape", "??_HOM*.shape". NB: strlwr-ed internally
recurs +true if want to recurs in sub directory
+
+
+Implements NL3D::UShapeBank. +
+Definition at line 80 of file shape_bank_user.cpp. +
+References _ShapeBank.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CShapeBankUser::removeShapeCache ( const std::string & shapeCacheName ) [virtual]
+
+ + + + + +
+ + + +
+Remove a ShapeCache. +
+All shapes in the shape cache are deleted. All links are redirected to the default ShapeCache. +
+Implements NL3D::UShapeBank. +
+Definition at line 49 of file shape_bank_user.cpp. +
+References _ShapeBank, and NL3D_MEM_SHAPE_BANK.
+

+ + + + +
+ + + + + + + + + +
void NL3D::CShapeBankUser::reset ( ) [virtual]
+
+ + + + + +
+ + + +
+Remove all ShapeCache and suppress all links (even the link to the default cache are removed). +
+ +
+Implements NL3D::UShapeBank. +
+Definition at line 57 of file shape_bank_user.cpp. +
+References _ShapeBank, and NL3D_MEM_SHAPE_BANK.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CShapeBankUser::setShapeCacheSize ( const std::string & shapeCacheName,
sint32 maxSize
) [virtual]
+
+ + + + + +
+ + + +
+Set the shapeCache shapeCacheName the new size.(delete shapes if maxsize<shapeCacheSize). +
+ +
+Implements NL3D::UShapeBank. +
+Definition at line 65 of file shape_bank_user.cpp. +
+References _ShapeBank, and NL3D_MEM_SHAPE_BANK.
+

Member Data Documentation

+ + + + +
+ + +
CShapeBank NL3D::CShapeBankUser::_ShapeBank +
+
+ + + + + +
+ + + +
+ +
+Definition at line 64 of file shape_bank_user.h. +
+Referenced by addShapeCache, linkShapeToShapeCache, preLoadShapesFromBNP, preLoadShapesFromDirectory, removeShapeCache, reset, and setShapeCacheSize.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CShapeBankUser Class Reference

Public Methods

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation