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

NL3D::CPSColorBlenderExact Class Reference

#include <ps_color.h> +

Inheritance diagram for NL3D::CPSColorBlenderExact: +

+ + + + + + + + +

Detailed Description

+these are some attribute makers for colors This is a int blender class. It just blend between 2 values. The blending is exact, and thus slow... +

+Here, we got color maker

See also:: ps_attrib_maker.h, ps_attrib_maker_template.h

+ +

+Definition at line 59 of file ps_color.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types
typedef CPSValueBlendFunc< T > functor_type
the type of the functor object

typedef T value_type
the type of the attribute to be produced

Public Member Functions
CPSAttribMakerBase * clone () const
CPSColorBlenderExact (NLMISC::CRGBA startColor=NLMISC::CRGBA::White, NLMISC::CRGBA endColor=NLMISC::CRGBA::Black, float nbCycles=1.0f)
virtual T get (float input)
virtual T 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 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)

virtual bool hasCustomInput (void)
bool isClampingSupported (void) const
NLMISC_DECLARE_CLASS (CPSColorBlenderExact)
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)

Data Fields
CPSValueBlendFunc< T > _F
the functor object

Protected Attributes
bool _HasMemory
float _NbCycles
+

Member Typedef Documentation

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

+ + + + +
+ + +
typedef T NL3D::CPSAttribMakerT< T , CPSValueBlendFunc< T > >::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::CPSColorBlenderExact::CPSColorBlenderExact ( NLMISC::CRGBA startColor = NLMISC::CRGBA::White,
NLMISC::CRGBA endColor = NLMISC::CRGBA::Black,
float nbCycles = 1.0f
) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 63 of file ps_color.h. +
+
00063 : CPSValueBlender<NLMISC::CRGBA>(nbCycles) +00064 { +00065 _F.setValues(startColor, endColor); +00066 } +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
CPSAttribMakerBase* NL3D::CPSColorBlenderExact::clone ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Implements NL3D::CPSAttribMakerBase. +
+Definition at line 67 of file ps_color.h. +
+
00067 { return new CPSColorBlenderExact(*this); } +

+

+ + + + +
+ + + + + + + + + + +
virtual T NL3D::CPSAttribMakerT< T , CPSValueBlendFunc< T > >::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< T >. +
+Definition at line 60 of file ps_attrib_maker_helper.h. +
+
00061 { +00062 NLMISC::OptFastFloorBegin(); +00063 nlassert(input >= 0.f && input <= 1.f); +00064 return _F(input); +00065 NLMISC::OptFastFloorEnd(); +00066 } +

+

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

+ + + + +
+ + + + + + + + + + +
virtual bool NL3D::CPSAttribMakerT< T , CPSValueBlendFunc< T > >::getClamping ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+Test if the clamping is enabled.
See also:
isClampingSupported()
+ +
+Reimplemented from NL3D::CPSAttribMaker< T >. +
+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< T , CPSValueBlendFunc< T > >::getInput ( void ) const [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+get the type of input (if supported). The default return attrDate
See also:
hasCustomInput()
+ +
+Reimplemented from NL3D::CPSAttribMaker< T >. +
+Definition at line 150 of file ps_attrib_maker_helper.h. +
+
00150 { return _InputType; } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
virtual T NL3D::CPSValueBlender< T >::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< T >. +
+Definition at line 173 of file ps_attrib_maker_template.h. +
+
00173 { return _F.getMaxValue(); } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
virtual T NL3D::CPSValueBlender< T >::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< T >. +
+Definition at line 174 of file ps_attrib_maker_template.h. +
+
00174 { return _F.getMinValue(); } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
float NL3D::CPSAttribMaker< T >::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 ; } +

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T>
virtual const char* NL3D::CPSAttribMaker< T >::getType ( ) [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< T , CPSValueBlendFunc< T > >::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< T >. +
+Definition at line 139 of file ps_attrib_maker_helper.h. +
+
00139 { return true; } +

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
bool NL3D::CPSAttribMaker< T >::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::CPSLocated::setLifeScheme(), and NL3D::CPSLocated::setMassScheme(). +
+
00282 { return _HasMemory ; } +

+

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

+

+ + + + +
+ + + + + + + + + + +
NL3D::CPSColorBlenderExact::NLMISC_DECLARE_CLASS ( CPSColorBlenderExact )
+
+ + + + + +
+ + + +
+
+

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

+

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

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T>
void NL3D::CPSAttribMaker< T >::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< T > NL3D::CPSAttribMakerT< T , CPSValueBlendFunc< T > >::_F [inherited] +
+
+ + + + + +
+ + + +
+the functor object +
+ +
+Definition at line 55 of file ps_attrib_maker_helper.h.
+

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

+ + + + +
+ + + + + +
+template<typename T>
float NL3D::CPSAttribMaker< T >::_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_color.h

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

+1.3.6

+ + -- cgit v1.2.1


Public Types
typedef CPSValueBlendFunc< T >	functor_type
	the type of the functor object
typedef T	value_type
	the type of the attribute to be produced
Public Member Functions
CPSAttribMakerBase *	clone () const
	CPSColorBlenderExact (NLMISC::CRGBA startColor=NLMISC::CRGBA::White, NLMISC::CRGBA endColor=NLMISC::CRGBA::Black, float nbCycles=1.0f)
virtual T	get (float input)
virtual T	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 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)
virtual bool	hasCustomInput (void)
bool	isClampingSupported (void) const
	NLMISC_DECLARE_CLASS (CPSColorBlenderExact)
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)
Data Fields
CPSValueBlendFunc< T >	_F
	the functor object
Protected Attributes
bool	_HasMemory
float	_NbCycles