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

This struct describe where. +More... +

+#include <ps_force.h> +

+Inheritance diagram for NL3D::CPSForce

Inheritance graph
+ + + + + + + + +
[legend]
Collaboration diagram for NL3D::CPSForce:

Collaboration graph
+ + + + + + + + + + + + +
[legend]
List of all members. + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 CPSForce ()
 Constructor. More...

uint32 getType (void) const
 return this bindable type. More...

virtual uint32 getPriority (void) const
 return priority for forces. More...

virtual bool doesProduceBBox (void) const
 Override of CPSLocatedBindable::doesProduceBBox(). forces usually are not part of the bbox. More...

virtual void step (TPSProcessPass pass, CAnimationTime ellapsedTime)
 process one pass for the force. More...

virtual void performMotion (CAnimationTime ellapsedTime) = 0
 Compute the force on the targets.

virtual void show (CAnimationTime ellapsedTime) = 0
 Show the force (edition mode).

virtual void serial (NLMISC::IStream &f)
 Serial the force definition. MUST be called by deriver during their serialisation. More...

virtual bool newElement (void) = 0
 Generate a new element for this bindable. More...

virtual void deleteElement (uint32 index) = 0
 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.

virtual void resize (uint32 size) = 0
 Resize the bindable attributes containers DERIVERS SHOULD CALL THEIR PARENT VERSION.

+

Detailed Description

+This struct describe where. +

+/** All forces in the system derive from this class It all a list all located on which the force can apply Only the motion and toolRender passes are supported for a force The corresponding virtual calls are done

+Author(s):
+ Nicolas Vizerie , Nevrax France
+Date:
+ 2001
+

+ +

+Definition at line 50 of file ps_force.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + +
+NL3D::CPSForce::CPSForce ( + +) +
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 43 of file ps_force.cpp.

+

Member Function Documentation

+

+ + + + +
+ + + + + + +
+void NL3D::CPSForce::deleteElement ( + +uint32 index ) [pure 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::CPSLocatedBindable. +

+Reimplemented in NL3D::CPSGravity, and NL3D::CPSSpring.

+

+ + + + +
+ + + + + + +
+bool NL3D::CPSForce::doesProduceBBox ( + +void ) const [inline, virtual] +
+
+ + + + + +
+   + + +

+Override of CPSLocatedBindable::doesProduceBBox(). forces usually are not part of the bbox. +

+ +

+Reimplemented from NL3D::CPSLocatedBindable. +

+Definition at line 67 of file ps_force.h.

+

+ + + + +
+ + + + + + +
+uint32 NL3D::CPSForce::getPriority ( + +void ) const [inline, virtual] +
+
+ + + + + +
+   + + +

+return priority for forces. +

+ +

+Reimplemented from NL3D::CPSLocatedBindable. +

+Definition at line 64 of file ps_force.h.

+

+ + + + +
+ + + + + + +
+uint32 NL3D::CPSForce::getType ( + +void ) const [inline, virtual] +
+
+ + + + + +
+   + + +

+return this bindable type. +

+ +

+Reimplemented from NL3D::CPSLocatedBindable. +

+Definition at line 59 of file ps_force.h.

+

+ + + + +
+ + + + + + +
+virtual bool NL3D::CPSForce::newElement ( + +void ) [pure virtual] +
+
+ + + + + +
+   + + +

+Generate a new element for this bindable. +

+They are generated according to the propertie of the class

+Returns:
+ true if it could be added
+

+Reimplemented from NL3D::CPSLocatedBindable. +

+Reimplemented in NL3D::CPSGravity, and NL3D::CPSSpring.

+

+ + + + +
+ + + + + + +
+void NL3D::CPSForce::performMotion ( + +CAnimationTime ellapsedTime ) [pure virtual] +
+
+ + + + + +
+   + + +

+Compute the force on the targets. +

+ +

+Reimplemented in NL3D::CPSGravity, and NL3D::CPSSpring.

+

+ + + + +
+ + + + + + +
+void NL3D::CPSForce::resize ( + +uint32 size ) [pure virtual] +
+
+ + + + + +
+   + + +

+Resize the bindable attributes containers DERIVERS SHOULD CALL THEIR PARENT VERSION. +

+ +

+Reimplemented from NL3D::CPSLocatedBindable. +

+Reimplemented in NL3D::CPSGravity, and NL3D::CPSSpring.

+

+ + + + +
+ + + + + + +
+void NL3D::CPSForce::serial ( + +NLMISC::IStream & f ) [virtual] +
+
+ + + + + +
+   + + +

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

+ +

+Reimplemented from NL3D::CPSTargetLocatedBindable. +

+Reimplemented in NL3D::CPSGravity, and NL3D::CPSSpring. +

+Definition at line 47 of file ps_force.cpp.

+

+ + + + +
+ + + + + + +
+void NL3D::CPSForce::show ( + +CAnimationTime ellapsedTime ) [pure virtual] +
+
+ + + + + +
+   + + +

+Show the force (edition mode). +

+ +

+Reimplemented in NL3D::CPSGravity, and NL3D::CPSSpring.

+

+ + + + +
+ + + + + + + + + + +
+void NL3D::CPSForce::step ( + +TPSProcessPass pass, +
+CAnimationTime ellapsedTime ) [virtual] +
+
+ + + + + +
+   + + +

+process one pass for the force. +

+ +

+Reimplemented from NL3D::CPSLocatedBindable. +

+Definition at line 58 of file ps_force.cpp.

+

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