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_1UShapeBank.html | 417 ++++++++++++++++++++++++++ 1 file changed, 417 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1UShapeBank.html (limited to 'docs/doxygen/nel/classNL3D_1_1UShapeBank.html') diff --git a/docs/doxygen/nel/classNL3D_1_1UShapeBank.html b/docs/doxygen/nel/classNL3D_1_1UShapeBank.html new file mode 100644 index 00000000..b506fa31 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1UShapeBank.html @@ -0,0 +1,417 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NL3D::UShapeBank Class Reference

Game interface for managing shape bank. +More... +

+#include <u_shape_bank.h> +

+

Inheritance diagram for NL3D::UShapeBank: +

+ +NL3D::CShapeBankUser + +List of all members. + + + + + + + + + + + + + + + +

Public Methods

virtual void addShapeCache (const std::string &shapeCacheName)=0
 Add a new ShapeCache. More...

virtual void removeShapeCache (const std::string &shapeCacheName)=0
 Remove a ShapeCache. More...

virtual void reset ()=0
 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)=0
 Set the shapeCache shapeCacheName the new size.(delete shapes if maxsize<shapeCacheSize). More...

virtual void linkShapeToShapeCache (const std::string &shapeName, const std::string &shapeCacheName)=0
 Link a shape to a ShapeCache. More...

virtual void preLoadShapesFromDirectory (const std::string &shapeCacheName, const std::string &path, const std::string &wildCard, bool recurs=false)=0
 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)=0
 PreLoad all shapes (.shape, .ps, .skel...) files from a directory into a shapeCache. More...

+

Detailed Description

+Game interface for managing shape bank. +

+

+Author:
+Matthieu Besson , Nevrax France
+Date:
+2001
+

+ +

+Definition at line 41 of file u_shape_bank.h.

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::UShapeBank::addShapeCache ( const std::string &   shapeCacheName )  [pure virtual]
+
+ + + + + +
+   + + +

+Add a new ShapeCache. +

+If already exist do nothing. +

+Implemented in NL3D::CShapeBankUser.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::UShapeBank::linkShapeToShapeCache ( const std::string &   shapeName,
const std::string &   shapeCacheName
)  [pure virtual]
+
+ + + + + +
+   + + +

+Link a shape to a ShapeCache. +

+The ShapeCache must exist and must not contains the shape. +

+Implemented in NL3D::CShapeBankUser.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NL3D::UShapeBank::preLoadShapesFromBNP ( const std::string &   shapeCacheName,
const std::string &   bnpName,
const std::string &   wildCard
)  [pure 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).
+
+

+Implemented in NL3D::CShapeBankUser.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NL3D::UShapeBank::preLoadShapesFromDirectory ( const std::string &   shapeCacheName,
const std::string &   path,
const std::string &   wildCard,
bool   recurs = false
)  [pure 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
+
+

+Implemented in NL3D::CShapeBankUser.

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::UShapeBank::removeShapeCache ( const std::string &   shapeCacheName )  [pure virtual]
+
+ + + + + +
+   + + +

+Remove a ShapeCache. +

+All shapes in the shape cache are deleted. All links are redirected to the default ShapeCache. +

+Implemented in NL3D::CShapeBankUser.

+

+ + + + +
+ + + + + + + + + +
virtual void NL3D::UShapeBank::reset (   )  [pure virtual]
+
+ + + + + +
+   + + +

+Remove all ShapeCache and suppress all links (even the link to the default cache are removed). +

+ +

+Implemented in NL3D::CShapeBankUser.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::UShapeBank::setShapeCacheSize ( const std::string &   shapeCacheName,
sint32   maxSize
)  [pure virtual]
+
+ + + + + +
+   + + +

+Set the shapeCache shapeCacheName the new size.(delete shapes if maxsize<shapeCacheSize). +

+ +

+Implemented in NL3D::CShapeBankUser.

+

The documentation for this class was generated from the following file: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1