From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/classNL3D_1_1CPSForceIntensity.html | 638 +++++++++++++++++++++ 1 file changed, 638 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CPSForceIntensity.html (limited to 'docs/doxygen/nel/classNL3D_1_1CPSForceIntensity.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CPSForceIntensity.html b/docs/doxygen/nel/classNL3D_1_1CPSForceIntensity.html new file mode 100644 index 00000000..f5cabdd5 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CPSForceIntensity.html @@ -0,0 +1,638 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NL3D::CPSForceIntensity Class Reference

this is a class to set force instensity (acceleration for gravity, k coefficient for springs...). +More... +

+#include <ps_force.h> +

Inheritance diagram for NL3D::CPSForceIntensity: +

+ + + + + + + + + + + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
	CPSForceIntensity ()
virtual	~CPSForceIntensity ()
float	getIntensity (void) const
	get the constant intensity that was set for the force. More...
virtual void	setIntensity (float value)
	set a constant intensity for the force. this discard any previous call to setIntensityScheme. More...
virtual void	setIntensityScheme (CPSAttribMaker< float > *scheme)
	set a non-constant intensity. More...
virtual void	setupFunctor (uint32 indexInLocated)
CPSAttribMaker< float > *	getIntensityScheme (void)
	get the attribute maker for a non constant intensity. More...
const CPSAttribMaker< float > *	getIntensityScheme (void) const
void	serialForceIntensity (NLMISC::IStream &f) throw (NLMISC::EStream)
Protected Methods
virtual CPSLocated *	getForceIntensityOwner (void)=0
	deriver must return the located that own them here. More...
void	newForceIntensityElement (CPSLocated *emitterLocated, uint32 emitterIndex)
void	deleteForceIntensityElement (uint32 index)
void	resizeForceIntensity (uint32 size)
Protected Attributes
float	_K
CPSAttribMaker< float > *	_IntensityScheme

Detailed Description

+this is a class to set force instensity (acceleration for gravity, k coefficient for springs...). +

+ +

+Definition at line 160 of file ps_force.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NL3D::CPSForceIntensity::CPSForceIntensity ( ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 165 of file ps_force.h. +
+References _IntensityScheme.
+

+ + + + +
+ + + + + + + + + +
NL3D::CPSForceIntensity::~CPSForceIntensity ( ) [virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 179 of file ps_force.cpp. +
+References _IntensityScheme.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSForceIntensity::deleteForceIntensityElement ( uint32 index ) [inline, protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 203 of file ps_force.h. +
+References _IntensityScheme, and index. +
+Referenced by NL3D::CPSTurbul::deleteElement, NL3D::CPSBrownianForce::deleteElement, NL3D::CPSFluidFriction::deleteElement, and NL3D::CPSForceIntensityHelper::deleteElement.
+

+ + + + +
+ + + + + + + + + + +
virtual CPSLocated* NL3D::CPSForceIntensity::getForceIntensityOwner ( void ) [protected, pure virtual]
+
+ + + + + +
+ + + +
+deriver must return the located that own them here. +
+ +
+Implemented in NL3D::CPSForceIntensityHelper. +
+Referenced by resizeForceIntensity, and setIntensityScheme.
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPSForceIntensity::getIntensity ( void ) const [inline]
+
+ + + + + +
+ + + +
+get the constant intensity that was set for the force. +
+ +
+Definition at line 173 of file ps_force.h. +
+References _K.
+

+ + + + +
+ + + + + + + + + + +
const CPSAttribMaker<float>* NL3D::CPSForceIntensity::getIntensityScheme ( void ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 186 of file ps_force.h. +
+References _IntensityScheme.
+

+ + + + +
+ + + + + + + + + + +
CPSAttribMaker<float>* NL3D::CPSForceIntensity::getIntensityScheme ( void ) [inline]
+
+ + + + + +
+ + + +
+get the attribute maker for a non constant intensity. +
+ +
+Definition at line 185 of file ps_force.h. +
+References _IntensityScheme.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPSForceIntensity::newForceIntensityElement ( CPSLocated * emitterLocated,
uint32 emitterIndex
) [inline, protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 199 of file ps_force.h. +
+References _IntensityScheme. +
+Referenced by NL3D::CPSTurbul::newElement, NL3D::CPSBrownianForce::newElement, NL3D::CPSFluidFriction::newElement, and NL3D::CPSForceIntensityHelper::newElement.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSForceIntensity::resizeForceIntensity ( uint32 size ) [inline, protected]
+
+ + + + + +
+ + + +
+ +
+Definition at line 207 of file ps_force.h. +
+References _IntensityScheme, and getForceIntensityOwner. +
+Referenced by NL3D::CPSTurbul::resize, NL3D::CPSBrownianForce::resize, NL3D::CPSFluidFriction::resize, and NL3D::CPSForceIntensityHelper::resize.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSForceIntensity::serialForceIntensity ( NLMISC::IStream & f ) throw (NLMISC::EStream)
+
+ + + + + +
+ + + +
+ +
+Definition at line 192 of file ps_force.cpp. +
+Referenced by NL3D::CPSTurbul::serial, and NL3D::CPSFluidFriction::serial.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSForceIntensity::setIntensity ( float value ) [virtual]
+
+ + + + + +
+ + + +
+set a constant intensity for the force. this discard any previous call to setIntensityScheme. +
+ +
+Reimplemented in NL3D::CPSGravity. +
+Definition at line 168 of file ps_force.cpp. +
+References _IntensityScheme, _K, and value. +
+Referenced by NL3D::CPSCentralGravity::CPSCentralGravity, NL3D::CPSCylindricVortex::CPSCylindricVortex, NL3D::CPSDirectionnalForce::CPSDirectionnalForce, NL3D::CPSFluidFriction::CPSFluidFriction, and NL3D::CPSSpring::CPSSpring.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPSForceIntensity::setIntensityScheme ( CPSAttribMaker< float > * scheme ) [virtual]
+
+ + + + + +
+ + + +
+set a non-constant intensity. +
+ +
+Reimplemented in NL3D::CPSGravity. +
+Definition at line 184 of file ps_force.cpp. +
+References _IntensityScheme, getForceIntensityOwner, and nlassert.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSForceIntensity::setupFunctor ( uint32 indexInLocated ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NL3D::CPSFluidFriction. +
+Definition at line 182 of file ps_force.h.
+

Member Data Documentation

+ + + + +
+ + +
CPSAttribMaker<float>* NL3D::CPSForceIntensity::_IntensityScheme [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 197 of file ps_force.h. +
+Referenced by CPSForceIntensity, deleteForceIntensityElement, getIntensityScheme, NL3D::CPSBrownianForce::isIntegrable, NL3D::CPSGravity::isIntegrable, newForceIntensityElement, NL3D::CPSBrownianForce::performDynamic, NL3D::CPSMagneticForce::performDynamic, NL3D::CPSCylindricVortex::performDynamic, NL3D::CPSSpring::performDynamic, NL3D::CPSCentralGravity::performDynamic, NL3D::CPSGravity::performDynamic, NL3D::CPSDirectionnalForce::performDynamic, resizeForceIntensity, setIntensity, NL3D::CPSBrownianForce::setIntensityScheme, NL3D::CPSGravity::setIntensityScheme, setIntensityScheme, NL3D::CPSTurbul::setupFunctor, NL3D::CPSFluidFriction::setupFunctor, and ~CPSForceIntensity.
+

+ + + + +
+ + +
float NL3D::CPSForceIntensity::_K [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 196 of file ps_force.h. +
+Referenced by getIntensity, NL3D::CPSBrownianForce::integrate, NL3D::CPSGravity::integrate, NL3D::CPSBrownianForce::integrateSingle, NL3D::CPSGravity::integrateSingle, NL3D::CPSBrownianForce::performDynamic, NL3D::CPSMagneticForce::performDynamic, NL3D::CPSCylindricVortex::performDynamic, NL3D::CPSSpring::performDynamic, NL3D::CPSCentralGravity::performDynamic, NL3D::CPSGravity::performDynamic, NL3D::CPSDirectionnalForce::performDynamic, setIntensity, NL3D::CPSTurbul::setupFunctor, and NL3D::CPSFluidFriction::setupFunctor.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CPSForceIntensity Class Reference

Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation