From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../doxygen/nel/classNL3D_1_1CPSFluidFriction.html | 379 +++++++++++++++++++++ 1 file changed, 379 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CPSFluidFriction.html (limited to 'docs/doxygen/nel/classNL3D_1_1CPSFluidFriction.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CPSFluidFriction.html b/docs/doxygen/nel/classNL3D_1_1CPSFluidFriction.html new file mode 100644 index 00000000..b447ebd1 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CPSFluidFriction.html @@ -0,0 +1,379 @@ + + + + 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::CPSFluidFriction Class Reference

the fluid friction force. +More... +

+#include <ps_force.h> +

Inheritance diagram for NL3D::CPSFluidFriction: +

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

Public Methods
	CPSFluidFriction (float frictionCoeff=1.f)
virtual void	setupFunctor (uint32 index)
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	Serial the force definition. MUST be called by deriver during their serialisation. More...
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...

Detailed Description

+the fluid friction force. +

+We don't derive from CPSForceIntensityHelper (which derives from CPSForce , because CIsotropicForceT also derives from CPSForce, and we don't want to use virtual inheritance +

+ +

+Definition at line 533 of file ps_force.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NL3D::CPSFluidFriction::CPSFluidFriction ( float frictionCoeff = 1.f ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 537 of file ps_force.h. +
+References NL3D::CPSLocatedBindable::_Name, and NL3D::CPSForceIntensity::setIntensity.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSFluidFriction::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< CPSFluidFrictionFunctor >. +
+Definition at line 567 of file ps_force.h. +
+References NL3D::CPSForceIntensity::deleteForceIntensityElement, and index.
+

+ + + + +
+ + + + + + + + + + +
virtual CPSLocated* NL3D::CPSFluidFriction::getForceIntensityOwner ( void ) [inline, protected, virtual]
+
+ + + + + +
+ + + +
+deriver must return the located that own them here. +
+ +
+Implements NL3D::CPSForceIntensity. +
+Definition at line 565 of file ps_force.h. +
+References NL3D::CPSLocatedBindable::_Owner, and NL3D::CPSForce::CPSLocated.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CPSFluidFriction::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< CPSFluidFrictionFunctor >. +
+Definition at line 566 of file ps_force.h. +
+References NL3D::CPSForce::CPSLocated, and NL3D::CPSForceIntensity::newForceIntensityElement.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSFluidFriction::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< CPSFluidFrictionFunctor >. +
+Definition at line 568 of file ps_force.h. +
+References NL3D::CPSForceIntensity::resizeForceIntensity.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSFluidFriction::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< CPSFluidFrictionFunctor >. +
+Definition at line 552 of file ps_force.h. +
+References NL3D::CPSForce::registerToTargets, and NL3D::CPSForceIntensity::serialForceIntensity.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CPSFluidFriction::setupFunctor ( uint32 index ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NL3D::CPSForceIntensity. +
+Definition at line 544 of file ps_force.h. +
+References NL3D::CIsotropicForceT< CPSFluidFrictionFunctor >::_F, NL3D::CPSForceIntensity::_IntensityScheme, NL3D::CPSForceIntensity::_K, NL3D::CPSLocatedBindable::_Owner, and index.
+

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

ps_force.h

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CPSFluidFriction Class Reference

Public Methods

Protected Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation