Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 

NL3D::CPSValueGradient< T > Class Template Reference

#include <ps_attrib_maker_template.h>

Inheritance diagram for NL3D::CPSValueGradient< T >:

NL3D::CPSAttribMakerT< T, CPSValueGradientFunc< T > > NL3D::CPSAttribMaker< T > NL3D::CPSAttribMakerBase NLMISC::IStreamable NLMISC::IClassable NL3D::CPSColorGradient

Detailed Description

template<typename T>
class NL3D::CPSValueGradient< T >

This is a Values gradient class To use this, just derive a class from a specialization of this template , create a ctor, and declare it to the class registry in the ctor, you should call _F.setValue to init the functor object

Definition at line 401 of file ps_attrib_maker_template.h.

Public Types

typedef CPSValueGradientFunc<
T > 		functor_type
 the type of the functor object

typedef T value_type
 the type of the attribute to be produced


Public Member Functions

virtual CPSAttribMakerBase * clone () const=0
 CPSValueGradient (float nbCycles)
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
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

CPSValueGradientFunc< T > _F
 the functor object


Protected Attributes

bool _HasMemory
float _NbCycles

Member Typedef Documentation

typedef CPSValueGradientFunc< T > NL3D::CPSAttribMakerT< T , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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

template<typename T>
NL3D::CPSValueGradient< T >::CPSValueGradient (  float  nbCycles  )  [inline]
 

ctor With nbCycles, you can set the pattern frequency. It is usually one. See ps_attrib_maker.h For further details

Definition at line 409 of file ps_attrib_maker_template.h. 

00409                                          : CPSAttribMakerT<T, CPSValueGradientFunc<T> >(nbCycles)
00410         {
00411         }

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.

template<typename T>
virtual void NL3D::CPSAttribMaker< T >::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< T >, NL3D::CPSAttribMakerMemoryBase< T >, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSAttribMakerMemoryBase< float >, NL3D::CPSAttribMakerMemoryBase< CPlaneBasis >, NL3D::CPSAttribMakerMemoryBase< NLMISC::CRGBA >, NL3D::CPSAttribMakerMemoryBase< uint32 >, and NL3D::CPSAttribMakerMemoryBase< sint32 >.

Definition at line 285 of file ps_attrib_maker.h. 

00285 { nlassert(false) ; }

virtual T NL3D::CPSAttribMakerT< T , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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::CPSValueGradient< 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 from NL3D::CPSAttribMaker< T >.

Definition at line 412 of file ps_attrib_maker_template.h. 

00412 { return _F.getMaxValue(); }

template<typename T>
virtual T NL3D::CPSValueGradient< 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 from NL3D::CPSAttribMaker< T >.

Definition at line 413 of file ps_attrib_maker_template.h. 

00413 { 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 , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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; }

template<typename T>
virtual void NL3D::CPSAttribMaker< T >::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::CPSAttribMakerBinOp< T >, NL3D::CPSAttribMakerMemoryBase< T >, NL3D::CPSAttribMakerMemory< uint32 >, NL3D::CPSAttribMakerMemory< sint32 >, NL3D::CPSAttribMakerMemory< float >, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSAttribMakerMemoryBase< float >, NL3D::CPSAttribMakerMemoryBase< CPlaneBasis >, NL3D::CPSAttribMakerMemoryBase< NLMISC::CRGBA >, NL3D::CPSAttribMakerMemoryBase< uint32 >, and NL3D::CPSAttribMakerMemoryBase< sint32 >.

Definition at line 290 of file ps_attrib_maker.h. 

00290 { nlassert(false) ; }

template<typename T>
virtual void NL3D::CPSAttribMaker< T >::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< T >, NL3D::CPSAttribMakerMemoryBase< T >, NL3D::CPSAttribMakerBinOp< float >, NL3D::CPSAttribMakerBinOp< CPlaneBasis >, NL3D::CPSAttribMakerBinOp< uint32 >, NL3D::CPSAttribMakerBinOp< NLMISC::CRGBA >, NL3D::CPSAttribMakerBinOp< sint32 >, NL3D::CPSAttribMakerMemoryBase< float >, NL3D::CPSAttribMakerMemoryBase< CPlaneBasis >, NL3D::CPSAttribMakerMemoryBase< NLMISC::CRGBA >, NL3D::CPSAttribMakerMemoryBase< uint32 >, and NL3D::CPSAttribMakerMemoryBase< sint32 >.

Definition at line 296 of file ps_attrib_maker.h.

Referenced by NL3D::CPSRotated2DParticle::setAngle2DScheme(), NL3D::CPSAttribMakerBinOp< sint32 >::setArg(), NL3D::CPSColoredParticle::setColorScheme(), NL3D::CPSModulatedEmitter::setEmitteeSpeedScheme(), NL3D::CPSEmitter::setGenNbScheme(), NL3D::CPSForceIntensity::setIntensityScheme(), NL3D::CPSEmitter::setPeriodScheme(), NL3D::CPSRotated3DPlaneParticle::setPlaneBasisScheme(), and NL3D::CPSTexturedParticle::setTextureIndexScheme(). 

00296 { nlassert(false) ; }

virtual void NL3D::CPSAttribMakerT< T , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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 , CPSValueGradientFunc< 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

CPSValueGradientFunc< T > NL3D::CPSAttribMakerT< T , CPSValueGradientFunc< 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:
Generated on Tue Mar 16 07:30:26 2004 for NeL by doxygen 1.3.6