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/a03246.html | 1098 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1098 insertions(+) create mode 100644 docs/doxygen/nel/a03246.html (limited to 'docs/doxygen/nel/a03246.html') diff --git a/docs/doxygen/nel/a03246.html b/docs/doxygen/nel/a03246.html new file mode 100644 index 00000000..79a9b3bc --- /dev/null +++ b/docs/doxygen/nel/a03246.html @@ -0,0 +1,1098 @@ + + +NeL: NL3D::CPSUIntBlender class Reference + + + +

NL3D::CPSUIntBlender Class Reference

#include <ps_int.h> +

Inheritance diagram for NL3D::CPSUIntBlender: +

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


Public Types
typedef CPSValueBlendFunc< + uint32 >	functor_type
	the type of the functor object
typedef uint32	value_type
	the type of the attribute to be produced
Public Member Functions
CPSAttribMakerBase *	clone () const
	CPSUIntBlender (uint32 startInt=0, uint32 endInt=10, float nbCycles=1.0f)
virtual void	deleteElement (uint32 index)
	delete an element, given its index. this must be called only if memory management is used.
virtual uint32	get (float input)
virtual uint32	get (CPSLocated *loc, uint32 index)
	compute one value of the attribute for the given index
virtual bool	getClamping (void) const
virtual std::string	getClassName ()=0
virtual CPSInputType	getInput (void) const
virtual uint32	getMaxValue (void) const
	get the min value, or an evalution that is guaranteed to be < to it (meaningful for ordered set only)
virtual uint32	getMinValue (void) const
	get the max value, or an evalution that is guaranteed to be > to it (meaningful for ordered set only)
float	getNbCycles (void) const
virtual const char *	getType ()
	inherited from CPSAttribMakerBase. Template specialization will do the job
virtual bool	hasCustomInput (void)
bool	hasMemory (void) const
bool	isClampingSupported (void) const
virtual void	newElement (CPSLocated *emitterLocated, uint32 emitterIndex)
	NLMISC_DECLARE_CLASS (CPSUIntBlender)
virtual void	resize (uint32 capacity, uint32 nbPresentElements)
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	serialisation of the object
virtual void	setClamping (bool enable=true)
virtual void	setInput (const CPSInputType &input)
void	setNbCycles (float nbCycles)
Data Fields
CPSValueBlendFunc< uint32 >	_F
	the functor object
Protected Attributes
bool	_HasMemory
float	_NbCycles

Member Typedef Documentation

+ + + + +
+ + +
typedef CPSValueBlendFunc< uint32 > NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::functor_type [inherited] +
+
+ + + + + +
+ + + +
+the type of the functor object +
+ +
+Definition at line 174 of file ps_attrib_maker_helper.h.
+

+ + + + +
+ + +
typedef uint32 NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::value_type [inherited] +
+
+ + + + + +
+ + + +
+the type of the attribute to be produced +
+ +
+Definition at line 171 of file ps_attrib_maker_helper.h.
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NL3D::CPSUIntBlender::CPSUIntBlender ( uint32 startInt = 0,
uint32 endInt = 10,
float nbCycles = 1.0f
) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 59 of file ps_int.h. +
+References uint32. +
+
00059 : CPSValueBlender<uint32>(nbCycles) +00060 { +00061 _F.setValues(startInt, endInt); +00062 } +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
CPSAttribMakerBase* NL3D::CPSUIntBlender::clone ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NL3D::CPSAttribMakerBase. +
+Definition at line 63 of file ps_int.h. +
+
00063 { return new CPSUIntBlender(*this); } +

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSAttribMaker< uint32 >::deleteElement ( uint32 index ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+delete an element, given its index. this must be called only if memory management is used. +
+ +
+Reimplemented in NL3D::CPSAttribMakerBinOp< uint32 >, and NL3D::CPSAttribMakerMemoryBase< uint32 >. +
+Definition at line 285 of file ps_attrib_maker.h. +
+Referenced by NL3D::CPSEmitter::deleteElement(). +
+
00285 { nlassert(false) ; } +

+

+ + + + +
+ + + + + + + + + + +
virtual uint32 NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::get ( float input ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+Direct lookup of the result value from a float input (if it makes sense). This bypass what was set with setInput The input must be in [0, 1[ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 60 of file ps_attrib_maker_helper.h. +
+References NL3D::CPSAttribMakerT< T, F >::_F, nlassert, NLMISC::OptFastFloorBegin(), and NLMISC::OptFastFloorEnd(). +
+
00061 { +00062 NLMISC::OptFastFloorBegin(); +00063 nlassert(input >= 0.f && input <= 1.f); +00064 return _F(input); +00065 NLMISC::OptFastFloorEnd(); +00066 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual uint32 NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::get ( CPSLocated * loc,
uint32 index
) [virtual, inherited]
+
+ + + + + +
+ + + +
+compute one value of the attribute for the given index +
+ +
+Implements NL3D::CPSAttribMaker< uint32 >.
+

+ + + + +
+ + + + + + + + + + +
virtual bool NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::getClamping ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+Test if the clamping is enabled.
See also:
isClampingSupported()
+ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 167 of file ps_attrib_maker_helper.h. +
+
00167 { return _Clamp; }; +

+

+ + + + +
+ + + + + + + + + +
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().
+

+ + + + +
+ + + + + + + + + + +
virtual CPSInputType NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::getInput ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+get the type of input (if supported). The default return attrDate
See also:
hasCustomInput()
+ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 150 of file ps_attrib_maker_helper.h. +
+
00150 { return _InputType; } +

+

+ + + + +
+ + + + + + + + + + +
virtual uint32 NL3D::CPSValueBlender< uint32 >::getMaxValue ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+get the min value, or an evalution that is guaranteed to be < to it (meaningful for ordered set only) +
+ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 173 of file ps_attrib_maker_template.h. +
+
00173 { return _F.getMaxValue(); } +

+

+ + + + +
+ + + + + + + + + + +
virtual uint32 NL3D::CPSValueBlender< uint32 >::getMinValue ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+get the max value, or an evalution that is guaranteed to be > to it (meaningful for ordered set only) +
+ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 174 of file ps_attrib_maker_template.h. +
+
00174 { return _F.getMinValue(); } +

+

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

+

+ + + + +
+ + + + + + + + + + +
const char * NL3D::CPSAttribMaker< uint32 >::getType ( void ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+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"; } +

+

+ + + + +
+ + + + + + + + + + +
virtual bool NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::hasCustomInput ( void ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+tells wether one may choose one attribute from a CPSLocated to use as an input. If false, the input(s) is fixed For this class, it is supported +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 139 of file ps_attrib_maker_helper.h. +
+
00139 { return true; } +

+

+ + + + +
+ + + + + + + + + + +
bool NL3D::CPSAttribMaker< uint32 >::hasMemory ( void ) const [inline, inherited]
+
+ + + + + +
+ + + +
+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::CPSEmitter::deleteElement(), NL3D::CPSEmitter::newElement(), and NL3D::CPSEmitter::resize(). +
+
00282 { return _HasMemory ; } +

+

+ + + + +
+ + + + + + + + + + +
bool NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::isClampingSupported ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+tells wether clamping is supported for the input (value can't go above MaxInputValue) +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 155 of file ps_attrib_maker_helper.h. +
+
00155 { return true; } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CPSAttribMaker< uint32 >::newElement ( CPSLocated * emitterLocated,
uint32 emitterIndex
) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+create a new element, and provides the emitter, this must be called only if this attribute maker has its own memory +
+Reimplemented in NL3D::CPSAttribMakerMemory< uint32 >, NL3D::CPSAttribMakerBinOp< uint32 >, and NL3D::CPSAttribMakerMemoryBase< uint32 >. +
+Definition at line 290 of file ps_attrib_maker.h. +
+Referenced by NL3D::CPSEmitter::newElement(). +
+
00290 { nlassert(false) ; } +

+

+ + + + +
+ + + + + + + + + + +
NL3D::CPSUIntBlender::NLMISC_DECLARE_CLASS ( CPSUIntBlender )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CPSAttribMaker< uint32 >::resize ( uint32 capacity,
uint32 nbPresentElements
) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+set a new capacity for the memorized attribute, and a number of used element. This usually is 0 , but during edition, this may not be ... so new element are created. this must be called only if this attribute maker has its own memory +
+Reimplemented in NL3D::CPSAttribMakerBinOp< uint32 >, and NL3D::CPSAttribMakerMemoryBase< uint32 >. +
+Definition at line 296 of file ps_attrib_maker.h. +
+Referenced by NL3D::CPSEmitter::resize(). +
+
00296 { nlassert(false) ; } +

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::serial ( NLMISC::IStream & f ) throw (NLMISC::EStream) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+serialisation of the object +
+The same as make4, but with n replication instead of 4
See also:
make4
+ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 104 of file ps_attrib_maker_helper.h. +
+References NL3D::CPSInputType::InputType, NL3D::CPSInputType::serial(), and sint. +
+
00105 { +00106 sint ver = f.serialVersion(2); +00107 CPSAttribMaker<T>::serial(f); +00108 f.serial(_F); +00109 switch (ver) +00110 { +00111 case 1: +00112 { +00113 CPSInputType it; +00114 f.serialEnum(it.InputType); +00115 _InputType = it; +00116 } +00117 break; +00118 case 2: +00119 f.serial(_InputType); +00120 break; +00121 } +00122 f.serial(_Clamp); +00123 } +

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::setClamping ( bool enable = true ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+Enable, disable the clamping of input values.
See also:
isClampingSupported()
+ +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 161 of file ps_attrib_maker_helper.h. +
+
00161 { _Clamp = enable; }; +

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::setInput ( const CPSInputType & input ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+set a new input type +
+Reimplemented from NL3D::CPSAttribMaker< uint32 >. +
+Definition at line 144 of file ps_attrib_maker_helper.h. +
+
00144 { _InputType = input; } +

+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSAttribMaker< uint32 >::setNbCycles ( float nbCycles ) [inline, inherited]
+
+ + + + + +
+ + + +
+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

+ + + + +
+ + +
CPSValueBlendFunc< uint32 > NL3D::CPSAttribMakerT< uint32 , CPSValueBlendFunc< uint32 > >::_F [inherited] +
+
+ + + + + +
+ + + +
+the functor object +
+ +
+Definition at line 55 of file ps_attrib_maker_helper.h.
+

+ + + + +
+ + +
bool NL3D::CPSAttribMaker< uint32 >::_HasMemory [protected, inherited] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 304 of file ps_attrib_maker.h.
+

+ + + + +
+ + +
float NL3D::CPSAttribMaker< uint32 >::_NbCycles [protected, inherited] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 301 of file ps_attrib_maker.h.
+

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

ps_int.h

Generated on Tue Mar 16 07:29:23 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1

NL3D::CPSUIntBlender Class Reference

Public Types

Public Member Functions

Data Fields

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation