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_1CPSTurbul.html | 518 +++++++++++++++++++++++++++ 1 file changed, 518 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CPSTurbul.html (limited to 'docs/doxygen/nel/classNL3D_1_1CPSTurbul.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CPSTurbul.html b/docs/doxygen/nel/classNL3D_1_1CPSTurbul.html new file mode 100644 index 00000000..c309e66f --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CPSTurbul.html @@ -0,0 +1,518 @@ + + + + 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::CPSTurbul Class Reference

#include <ps_force.h> +

+

Inheritance diagram for NL3D::CPSTurbul: +

+ +NL3D::CIsotropicForceT< CPSTurbulForceFunc > +NL3D::CPSForceIntensity +NL3D::CPSForce +NL3D::CPSTargetLocatedBindable +NL3D::CPSLocatedBindable +NLMISC::IStreamable +NLMISC::IClassable + +List of all members. + + + + + + + + + + + + + + + + + + +

Public Methods

 CPSTurbul (float scale=1.f, uint numOctaves=4)
float getScale (void) const
void setScale (float scale)
uint getNumOctaves (void) const
void setNumOctaves (uint numOctaves)
virtual void serial (NLMISC::IStream &f) throw (NLMISC::EStream)
 Serial the force definition. MUST be called by deriver during their serialisation. More...

virtual void setupFunctor (uint32 index)

Protected Methods

virtual CPSLocated * getForceIntensityOwner (void)
 deriver must return the located that own them here. More...

virtual void newElement (CPSLocated *emitterLocated, uint32 emitterIndex)
 Generate a new element for this bindable. More...

virtual void deleteElement (uint32 index)
 Delete an element given its index Attributes of the located that hold this bindable are still accessible for of the index given index out of range -> nl_assert. More...

virtual void resize (uint32 size)
 Resize the bindable attributes containers DERIVERS SHOULD CALL THEIR PARENT VERSION should not be called directly. More...

+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
NL3D::CPSTurbul::CPSTurbul ( float   scale = 1.f,
uint   numOctaves = 4
)  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 678 of file ps_force.h. +

+References NL3D::CPSLocatedBindable::_Name, nlassert, setNumOctaves, and setScale.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSTurbul::deleteElement ( uint32   index )  [inline, protected, virtual]
+
+ + + + + +
+   + + +

+Delete an element given its index Attributes of the located that hold this bindable are still accessible for of the index given index out of range -> nl_assert. +

+ +

+Reimplemented from NL3D::CIsotropicForceT< CPSTurbulForceFunc >. +

+Definition at line 717 of file ps_force.h. +

+References NL3D::CPSForceIntensity::deleteForceIntensityElement, and index.

+

+ + + + +
+ + + + + + + + + + +
virtual CPSLocated* NL3D::CPSTurbul::getForceIntensityOwner ( void   )  [inline, protected, virtual]
+
+ + + + + +
+   + + +

+deriver must return the located that own them here. +

+ +

+Implements NL3D::CPSForceIntensity. +

+Definition at line 715 of file ps_force.h. +

+References NL3D::CPSLocatedBindable::_Owner, and NL3D::CPSForce::CPSLocated.

+

+ + + + +
+ + + + + + + + + + +
uint NL3D::CPSTurbul::getNumOctaves ( void   )  const [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 691 of file ps_force.h. +

+References NL3D::CIsotropicForceT< CPSTurbulForceFunc >::_F.

+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPSTurbul::getScale ( void   )  const [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 687 of file ps_force.h. +

+References NL3D::CIsotropicForceT< CPSTurbulForceFunc >::_F.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CPSTurbul::newElement ( CPSLocated *   emitterLocated,
uint32   emitterIndex
)  [inline, protected, virtual]
+
+ + + + + +
+   + + +

+Generate a new element for this bindable. +

+They are generated according to the propertie of the class +

+Reimplemented from NL3D::CIsotropicForceT< CPSTurbulForceFunc >. +

+Definition at line 716 of file ps_force.h. +

+References NL3D::CPSForce::CPSLocated, and NL3D::CPSForceIntensity::newForceIntensityElement.

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSTurbul::resize ( uint32   size )  [inline, protected, virtual]
+
+ + + + + +
+   + + +

+Resize the bindable attributes containers DERIVERS SHOULD CALL THEIR PARENT VERSION should not be called directly. +

+Call CPSLOcated::resize instead +

+Reimplemented from NL3D::CIsotropicForceT< CPSTurbulForceFunc >. +

+Definition at line 718 of file ps_force.h. +

+References NL3D::CPSForceIntensity::resizeForceIntensity.

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSTurbul::serial ( NLMISC::IStream &   f )  throw (NLMISC::EStream) [inline, virtual]
+
+ + + + + +
+   + + +

+Serial the force definition. MUST be called by deriver during their serialisation. +

+ +

+Reimplemented from NL3D::CIsotropicForceT< CPSTurbulForceFunc >. +

+Definition at line 697 of file ps_force.h. +

+References NL3D::CPSForce::registerToTargets, and NL3D::CPSForceIntensity::serialForceIntensity.

+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSTurbul::setNumOctaves ( uint   numOctaves )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 692 of file ps_force.h. +

+References NL3D::CIsotropicForceT< CPSTurbulForceFunc >::_F. +

+Referenced by CPSTurbul.

+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSTurbul::setScale ( float   scale )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 688 of file ps_force.h. +

+References NL3D::CIsotropicForceT< CPSTurbulForceFunc >::_F. +

+Referenced by CPSTurbul.

+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSTurbul::setupFunctor ( uint32   index )  [inline, virtual]
+
+ + + + + +
+   + + +

+ +

+Reimplemented from NL3D::CPSForceIntensity. +

+Definition at line 709 of file ps_force.h. +

+References NL3D::CIsotropicForceT< CPSTurbulForceFunc >::_F, NL3D::CPSForceIntensity::_IntensityScheme, NL3D::CPSForceIntensity::_K, NL3D::CPSLocatedBindable::_Owner, and index.

+

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