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/a03136.html | 1307 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1307 insertions(+) create mode 100644 docs/doxygen/nel/a03136.html (limited to 'docs/doxygen/nel/a03136.html') diff --git a/docs/doxygen/nel/a03136.html b/docs/doxygen/nel/a03136.html new file mode 100644 index 00000000..355e8cc0 --- /dev/null +++ b/docs/doxygen/nel/a03136.html @@ -0,0 +1,1307 @@ + + +NeL: TemplateNL3D::CPSAttribMaker< T > class Reference + + + +

NL3D::CPSAttribMaker< T > Class Template Reference

#include <ps_attrib_maker.h> +

Inheritance diagram for NL3D::CPSAttribMaker< T >: +

+ + + + + + + + + + + + + + + + +

Detailed Description

template<typename T>
+ class NL3D::CPSAttribMaker< T >

+ +This is a base class for any attrib maker. It produce an attribute used in a particle system. It can be used to fill a vertex buffer, or a table.

Author:: Nicolas Vizerie
+Nevrax France

Date:: 2001

+ +

+Definition at line 127 of file ps_attrib_maker.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Object
CPSAttribMaker (float nbCycles=1.f)
virtual const char * getType ()
inherited from CPSAttribMakerBase. Template specialization will do the job

virtual void serial (NLMISC::IStream &f) throw (NLMISC::EStream)
serialisation of the object. Derivers MUST call this, (if they use the attribute of this class at least)

virtual ~CPSAttribMaker ()
dtor

Production of attribute
virtual T get (float input)
virtual T get (CPSLocated *loc, uint32 index)=0
compute one value of the attribute from the given located at the given index

virtual void * make (CPSLocated *loc, uint32 startIndex, void *tab, uint32 stride, uint32 numAttrib, bool allowNoCopy=false, uint32 srcStep=(1<< 16)) const=0
virtual void make4 (CPSLocated *loc, uint32 startIndex, void *tab, uint32 stride, uint32 numAttrib, uint32 srcStep=(1<< 16)) const=0
virtual void makeN (CPSLocated *loc, uint32 startIndex, void *tab, uint32 stride, uint32 numAttrib, uint32 nbReplicate, uint32 srcStep=(1<< 16)) const=0

Input properties of the attribute maker
virtual bool getClamping (void) const
virtual CPSInputType getInput (void) const
float getNbCycles (void) const
virtual bool hasCustomInput (void)
tells wether one may choose one attribute from a CPSLocated to use as an input. If false, the input(s) is fixed

virtual bool isClampingSupported (void) const
virtual void setClamping (bool enable=true)
virtual void setInput (const CPSInputType &input)
void setNbCycles (float nbCycles)

Public Member Functions
virtual CPSAttribMakerBase * clone () const=0
virtual std::string getClassName ()=0
virtual T getMaxValue (void) const
get the min value, or an evalution that is guaranteed to be < to it (meaningful for ordered set only)

virtual T getMinValue (void) const
get the max value, or an evalution that is guaranteed to be > to it (meaningful for ordered set only)

Protected Attributes
bool _HasMemory
float _NbCycles
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
NL3D::CPSAttribMaker< T >::CPSAttribMaker ( float nbCycles = 1.f ) [inline]
+
+ + + + + +
+ + + +
+construct the attrib maker specifying the number of cycles to do.
See also:
setNbCycles()
+ +
+Definition at line 135 of file ps_attrib_maker.h. +
+
00135 : _NbCycles(nbCycles), _HasMemory(false) +00136 { +00137 } +

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T>
virtual NL3D::CPSAttribMaker< T >::~CPSAttribMaker ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+dtor +
+ +
+Definition at line 150 of file ps_attrib_maker.h. +
+
00150 {} +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
virtual CPSAttribMakerBase* NL3D::CPSAttribMakerBase::clone ( ) const [pure virtual, inherited]
+
+ + + + + +
+ + + +
+ +
+Implemented in NL3D::CPSColorBlenderExact, NL3D::CPSColorBlender, NL3D::CPSColorGradient, NL3D::CPSColorMemory, NL3D::CPSColorBinOp, NL3D::CPSFloatBlender, NL3D::CPSFloatGradient, NL3D::CPSFloatMemory, NL3D::CPSFloatBinOp, NL3D::CPSFloatCurve, NL3D::CPSIntBlender, NL3D::CPSUIntBlender, NL3D::CPSIntGradient, NL3D::CPSUIntGradient, NL3D::CPSIntMemory, NL3D::CPSUIntMemory, NL3D::CPSIntBinOp, NL3D::CPSUIntBinOp, NL3D::CPSPlaneBasisBlender, NL3D::CPSPlaneBasisGradient, NL3D::CPSPlaneBasisFollowSpeed, NL3D::CPSPlaneBasisMemory, NL3D::CPSPlaneBasisBinOp, and NL3D::CPSBasisSpinner.
+

+ + + + +
+ + + + + + + + + +
virtual std::string NLMISC::IClassable::getClassName ( ) [pure virtual, inherited]
+
+ + + + + +
+ + + +
+ +
+Implemented in NLAIAGENT::CNumericIndex, NLAIC::IPointerGestion, NLAIC::CIdentType, and CAutomataDesc. +
+Referenced by NLMISC::CClassRegistry::checkObject(), and NL3D::GetTextureSize().
+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
virtual T NL3D::CPSAttribMaker< T >::getMaxValue ( void ) const [inline, virtual]
+
+ + + + + +
+ + + +
+get the min value, or an evalution that is guaranteed to be < to it (meaningful for ordered set only) +
+ +
+Reimplemented in NL3D::CPSAttribMakerBinOp< T >, NL3D::CPSAttribMakerMemory< uint32 >, NL3D::CPSAttribMakerMemory< sint32 >, NL3D::CPSAttribMakerMemory< float >, NL3D::CPSValueBlender< T >, NL3D::CPSValueBlenderSample< T, n >, NL3D::CPSValueGradient< T >, NL3D::CPSFloatCurve, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSValueBlender< float >, NL3D::CPSValueBlender< CPlaneBasis >, NL3D::CPSValueBlender< uint32 >, NL3D::CPSValueBlender< NLMISC::CRGBA >, NL3D::CPSValueBlender< sint32 >, NL3D::CPSValueBlenderSample< NLMISC::CRGBA, 64 >, NL3D::CPSValueGradient< float >, NL3D::CPSValueGradient< CPlaneBasis >, NL3D::CPSValueGradient< NLMISC::CRGBA >, NL3D::CPSValueGradient< uint32 >, and NL3D::CPSValueGradient< sint32 >. +
+Definition at line 217 of file ps_attrib_maker.h. +
+
00217 { return T() ; /* no mean by default */ } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
virtual T NL3D::CPSAttribMaker< T >::getMinValue ( void ) const [inline, virtual]
+
+ + + + + +
+ + + +
+get the max value, or an evalution that is guaranteed to be > to it (meaningful for ordered set only) +
+ +
+Reimplemented in NL3D::CPSAttribMakerBinOp< T >, NL3D::CPSAttribMakerMemory< uint32 >, NL3D::CPSAttribMakerMemory< sint32 >, NL3D::CPSAttribMakerMemory< float >, NL3D::CPSValueBlender< T >, NL3D::CPSValueBlenderSample< T, n >, NL3D::CPSValueGradient< T >, NL3D::CPSFloatCurve, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSValueBlender< float >, NL3D::CPSValueBlender< CPlaneBasis >, NL3D::CPSValueBlender< uint32 >, NL3D::CPSValueBlender< NLMISC::CRGBA >, NL3D::CPSValueBlender< sint32 >, NL3D::CPSValueBlenderSample< NLMISC::CRGBA, 64 >, NL3D::CPSValueGradient< float >, NL3D::CPSValueGradient< CPlaneBasis >, NL3D::CPSValueGradient< NLMISC::CRGBA >, NL3D::CPSValueGradient< uint32 >, and NL3D::CPSValueGradient< sint32 >. +
+Definition at line 215 of file ps_attrib_maker.h. +
+
00215 { return T() ; /* no mean by default */ } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
float NL3D::CPSAttribMaker< T >::getNbCycles ( void ) const [inline]
+
+ + + + + +
+ + + +
+Retrieve the number of cycles
See also:
setNbCycles()
+ +
+Definition at line 236 of file ps_attrib_maker.h. +
+
00236 { return _NbCycles ; } +

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T>
virtual const char* NL3D::CPSAttribMaker< T >::getType ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+inherited from CPSAttribMakerBase. Template specialization will do the job +
+ +
+Implements NL3D::CPSAttribMakerBase. +
+Definition at line 147 of file ps_attrib_maker.h. +
+
00147 { return "UNKNOWN"; } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
bool NL3D::CPSAttribMaker< T >::hasMemory ( void ) const [inline]
+
+ + + + + +
+ + + +
+Some attribute makers may hold memory. this return true when this is the case. This also mean that you must call newElement, deleteElement, and resize, when it is called for the owning object (which is likely to be a CPSLocatedBindable) +
+Definition at line 282 of file ps_attrib_maker.h. +
+Referenced by NL3D::CPSLocated::setLifeScheme(), and NL3D::CPSLocated::setMassScheme(). +
+
00282 { return _HasMemory ; } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+template<typename T>
virtual void* NL3D::CPSAttribMaker< T >::make ( CPSLocated * loc,
uint32 startIndex,
void * tab,
uint32 stride,
uint32 numAttrib,
bool allowNoCopy = false,
uint32 srcStep = (1<< 16)
) const [pure virtual]
+
+ + + + + +
+ + + +
+Fill tab with an attribute by using the given stride. It fills numAttrib attributes.
Parameters:
+ + + + + + + + +
loc the 'located' that hold the 'located bindable' that need an attribute to be filled
startIndex usually 0, it gives the index of the first element in the located (is it multiplied by the step)
tab where the data will be written
stride the stride, in byte, between each value to write
numAttrib the number of attributes to compute
allowNoCopy data may be already present in memory, and may not need computation. When set to true, this allow no computation to be made the return parameter is then le location of the datas. this may be tab (if recomputation where needed), or another value for this to work, the stride must most of the time be sizeof(T). This is intended to be used with derivers of CPSAttribMaker that store values that do not depend on the input. The make method then just copy the data, we is sometime useless
srcStep A fixed-point 16:16 value that gives the step for the source iterator
+
+
Returns:
where the data have been copied, this is always tab, unless allowNoCopy is set to true, in which case this may be different
+ +
+Implemented in NL3D::CPSAttribMakerBinOp< T >, NL3D::CPSAttribMakerT< T, F >, NL3D::CPSAttribMakerMemoryBase< T >, NL3D::CPSPlaneBasisFollowSpeed, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueGradientFunc< NLMISC::CRGBA > >, NL3D::CPSAttribMakerT< sint32, CPSValueBlendFunc< sint32 > >, NL3D::CPSAttribMakerT< T, CPSValueGradientFunc< T > >, NL3D::CPSAttribMakerT< sint32, CPSValueGradientFunc< sint32 > >, NL3D::CPSAttribMakerT< uint32, CPSValueGradientFunc< uint32 > >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueBlendFunc< NLMISC::CRGBA > >, NL3D::CPSAttribMakerT< float, CPSFloatCurveFunctor >, NL3D::CPSAttribMakerT< CPlaneBasis, CPSValueBlendFunc< CPlaneBasis > >, NL3D::CPSAttribMakerT< float, CPSValueGradientFunc< float > >, NL3D::CPSAttribMakerT< float, CPSValueBlendFunc< float > >, NL3D::CPSAttribMakerT< T, CPSValueBlendSampleFunc< T, n > >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueBlendSampleFunc< NLMISC::CRGBA, n > >, NL3D::CPSAttribMakerT< CPlaneBasis, CPSValueGradientFunc< CPlaneBasis > >, NL3D::CPSAttribMakerT< CPlaneBasis, CSpinnerFunctor >, NL3D::CPSAttribMakerT< T, CPSValueBlendFunc< T > >, NL3D::CPSAttribMakerT< uint32, CPSValueBlendFunc< uint32 > >, NL3D::CPSAttribMakerMemoryBase< float >, NL3D::CPSAttribMakerMemoryBase< CPlaneBasis >, NL3D::CPSAttribMakerMemoryBase< NLMISC::CRGBA >, NL3D::CPSAttribMakerMemoryBase< uint32 >, and NL3D::CPSAttribMakerMemoryBase< sint32 >. +
+Referenced by NL3D::DrawDot().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+template<typename T>
virtual void NL3D::CPSAttribMaker< T >::make4 ( CPSLocated * loc,
uint32 startIndex,
void * tab,
uint32 stride,
uint32 numAttrib,
uint32 srcStep = (1<< 16)
) const [pure virtual]
+
+ + + + + +
+ + + +
+The same as make, but it replicate each attribute 4 times, thus filling 4*numAttrib. Useful for facelookat and the like
See also:
make()
+ +
+Implemented in NL3D::CPSAttribMakerBinOp< T >, NL3D::CPSAttribMakerT< T, F >, NL3D::CPSAttribMakerMemoryBase< T >, NL3D::CPSPlaneBasisFollowSpeed, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueGradientFunc< NLMISC::CRGBA > >, NL3D::CPSAttribMakerT< sint32, CPSValueBlendFunc< sint32 > >, NL3D::CPSAttribMakerT< T, CPSValueGradientFunc< T > >, NL3D::CPSAttribMakerT< sint32, CPSValueGradientFunc< sint32 > >, NL3D::CPSAttribMakerT< uint32, CPSValueGradientFunc< uint32 > >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueBlendFunc< NLMISC::CRGBA > >, NL3D::CPSAttribMakerT< float, CPSFloatCurveFunctor >, NL3D::CPSAttribMakerT< CPlaneBasis, CPSValueBlendFunc< CPlaneBasis > >, NL3D::CPSAttribMakerT< float, CPSValueGradientFunc< float > >, NL3D::CPSAttribMakerT< float, CPSValueBlendFunc< float > >, NL3D::CPSAttribMakerT< T, CPSValueBlendSampleFunc< T, n > >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueBlendSampleFunc< NLMISC::CRGBA, n > >, NL3D::CPSAttribMakerT< CPlaneBasis, CPSValueGradientFunc< CPlaneBasis > >, NL3D::CPSAttribMakerT< CPlaneBasis, CSpinnerFunctor >, NL3D::CPSAttribMakerT< T, CPSValueBlendFunc< T > >, NL3D::CPSAttribMakerT< uint32, CPSValueBlendFunc< uint32 > >, NL3D::CPSAttribMakerMemoryBase< float >, NL3D::CPSAttribMakerMemoryBase< CPlaneBasis >, NL3D::CPSAttribMakerMemoryBase< NLMISC::CRGBA >, NL3D::CPSAttribMakerMemoryBase< uint32 >, and NL3D::CPSAttribMakerMemoryBase< sint32 >.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+template<typename T>
virtual void NL3D::CPSAttribMaker< T >::makeN ( CPSLocated * loc,
uint32 startIndex,
void * tab,
uint32 stride,
uint32 numAttrib,
uint32 nbReplicate,
uint32 srcStep = (1<< 16)
) const [pure virtual]
+
+ + + + + +
+ + + +
+The same as make4, but with n replication instead of 4
See also:
make4
+ +
+Implemented in NL3D::CPSAttribMakerBinOp< T >, NL3D::CPSAttribMakerT< T, F >, NL3D::CPSAttribMakerMemoryBase< T >, NL3D::CPSPlaneBasisFollowSpeed, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueGradientFunc< NLMISC::CRGBA > >, NL3D::CPSAttribMakerT< sint32, CPSValueBlendFunc< sint32 > >, NL3D::CPSAttribMakerT< T, CPSValueGradientFunc< T > >, NL3D::CPSAttribMakerT< sint32, CPSValueGradientFunc< sint32 > >, NL3D::CPSAttribMakerT< uint32, CPSValueGradientFunc< uint32 > >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueBlendFunc< NLMISC::CRGBA > >, NL3D::CPSAttribMakerT< float, CPSFloatCurveFunctor >, NL3D::CPSAttribMakerT< CPlaneBasis, CPSValueBlendFunc< CPlaneBasis > >, NL3D::CPSAttribMakerT< float, CPSValueGradientFunc< float > >, NL3D::CPSAttribMakerT< float, CPSValueBlendFunc< float > >, NL3D::CPSAttribMakerT< T, CPSValueBlendSampleFunc< T, n > >, NL3D::CPSAttribMakerT< NLMISC::CRGBA, CPSValueBlendSampleFunc< NLMISC::CRGBA, n > >, NL3D::CPSAttribMakerT< CPlaneBasis, CPSValueGradientFunc< CPlaneBasis > >, NL3D::CPSAttribMakerT< CPlaneBasis, CSpinnerFunctor >, NL3D::CPSAttribMakerT< T, CPSValueBlendFunc< T > >, NL3D::CPSAttribMakerT< uint32, CPSValueBlendFunc< uint32 > >, NL3D::CPSAttribMakerMemoryBase< float >, NL3D::CPSAttribMakerMemoryBase< CPlaneBasis >, NL3D::CPSAttribMakerMemoryBase< NLMISC::CRGBA >, NL3D::CPSAttribMakerMemoryBase< uint32 >, and NL3D::CPSAttribMakerMemoryBase< sint32 >.
+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
void NL3D::CPSAttribMaker< T >::setNbCycles ( float nbCycles ) [inline]
+
+ + + + + +
+ + + +
+Set the number of cycles that must be done during the life of a particle, or the number of cycle per second for a particle that has no life limit. It is used to multiply the input used by this attribute maker It must be >= 0 +
+Definition at line 227 of file ps_attrib_maker.h. +
+
00228 { +00229 nlassert(nbCycles >= 0) ; +00230 _NbCycles = nbCycles ; +00231 } +

+

Field Documentation

+ + + + +
+ + + + + +
+template<typename T>
bool NL3D::CPSAttribMaker< T >::_HasMemory [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 304 of file ps_attrib_maker.h.
+

+ + + + +
+ + + + + +
+template<typename T>
float NL3D::CPSAttribMaker< T >::_NbCycles [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 301 of file ps_attrib_maker.h.
+

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

ps_attrib_maker.h

Generated on Tue Mar 16 07:03:19 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Object
	CPSAttribMaker (float nbCycles=1.f)
virtual const char *	getType ()
	inherited from CPSAttribMakerBase. Template specialization will do the job
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	serialisation of the object. Derivers MUST call this, (if they use the attribute of this class at least)
virtual	~CPSAttribMaker ()
	dtor
Production of attribute
virtual T	get (float input)
virtual T	get (CPSLocated *loc, uint32 index)=0
	compute one value of the attribute from the given located at the given index
virtual void *	make (CPSLocated loc, uint32 startIndex, void tab, uint32 stride, uint32 numAttrib, bool allowNoCopy=false, uint32 srcStep=(1<< 16)) const=0
virtual void	make4 (CPSLocated loc, uint32 startIndex, void tab, uint32 stride, uint32 numAttrib, uint32 srcStep=(1<< 16)) const=0
virtual void	makeN (CPSLocated loc, uint32 startIndex, void tab, uint32 stride, uint32 numAttrib, uint32 nbReplicate, uint32 srcStep=(1<< 16)) const=0
Input properties of the attribute maker
virtual bool	getClamping (void) const
virtual CPSInputType	getInput (void) const
float	getNbCycles (void) const
virtual bool	hasCustomInput (void)
	tells wether one may choose one attribute from a CPSLocated to use as an input. If false, the input(s) is fixed
virtual bool	isClampingSupported (void) const
virtual void	setClamping (bool enable=true)
virtual void	setInput (const CPSInputType &input)
void	setNbCycles (float nbCycles)
Public Member Functions
virtual CPSAttribMakerBase *	clone () const=0
virtual std::string	getClassName ()=0
virtual T	getMaxValue (void) const
	get the min value, or an evalution that is guaranteed to be < to it (meaningful for ordered set only)
virtual T	getMinValue (void) const
	get the max value, or an evalution that is guaranteed to be > to it (meaningful for ordered set only)
Protected Attributes
bool	_HasMemory
float	_NbCycles

NL3D::CPSAttribMaker< T > Class Template Reference

Detailed Description

template<typename T> + class NL3D::CPSAttribMaker< T >

Object

Production of attribute

Input properties of the attribute maker

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<typename T>
+ class NL3D::CPSAttribMaker< T >