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

an instance of these class can be bound to a particle system located this include forces, particle, and so on... +More... +

+#include <ps_located.h> +

+Inheritance diagram for NL3D::CPSLocatedBindable

+ + + + + + + + + + + + + + + + +[legend]Collaboration diagram for NL3D::CPSLocatedBindable:

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

Public Methods
virtual uint32	getType (void) const = 0
	Gives the type for this bindable. More...
virtual uint32	getPriority (void) const = 0
	Get the priority of the bindable The more high it is, the earlier it is dealt with.
	CPSLocatedBindable ()
	ctor. More...
virtual void	serial (NLMISC::IStream &f)
	serialization. More...
virtual	~CPSLocatedBindable ()
	dtor. More...
virtual void	step (TPSProcessPass pass, CAnimationTime ellapsedTime) = 0
	process one pass for this bindable.
virtual bool	completeBBox (NLMISC::CAABBox &box) const
virtual bool	doesProduceBBox (void) const
IDriver*	getDriver () const
	shortcut to get an instance of the driver. More...
CFontGenerator*	getFontGenerator (void)
	Shortcut to get the font generator if one was set. More...
const CFontGenerator*	getFontGenerator (void) const
	Shortcut to get the font generator if one was set (const version). More...
CFontManager*	getFontManager (void)
	Shortcut to get the font manager if one was set. More...
const CFontManager*	getFontManager (void) const
	Shortcut to get the font manager if one was set (const version). More...
const CMatrix&	getSysMat (void) const
	Shortcut to get the matrix of the system. More...
const CMatrix&	getInvertedSysMat (void) const
	shortcut to get the inverted matrix of the system. More...
const CMatrix&	getLocatedMat (void) const
	Get the matrix applied to this set of located bindable It may be the identity or the system matrix. More...
const CMatrix&	getInvertedLocatedMat (void) const
	Get the matrix applied to this set of located bindable It may be the identity or the inverted system matrix. More...
const CMatrix&	getViewMat (void) const
	shortcut to get the view matrix (trasposed). More...
void	setupDriverModelMatrix (void)
	shortcut to setup the model matrix (system basis or world basis). More...
CVector	computeI (void) const
	Compute a vector that will map to (1 0 0) after view and model transform. More...
CVector	computeK (void) const
	Compute a vector that will map to (0 0 1) after view and model transform. More...
CPSLocated*	getOwner (void)
	get the located that owns this bindable. More...
const CPSLocated*	getOwner (void) const
	get the located that owns this bindable (const version). More...
Protected Methods
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 (pos etc...) 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.
virtual void	setOwner (CPSLocated *psl)
	set the located that hold this located bindable. More...
Protected Attributes
CPSLocated*	_Owner
Friends
class	CPSLocated

Detailed Description

+an instance of these class can be bound to a particle system located this include forces, particle, and so on... +

+ +

+Definition at line 552 of file ps_located.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + +
+NL3D::CPSLocatedBindable::CPSLocatedBindable ( + +) [inline] +
+
+ + + + + +
+ + + +
+ctor. +
+ +
+Definition at line 569 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+NL3D::CPSLocatedBindable::~CPSLocatedBindable ( + +) [inline, virtual] +
+
+ + + + + +
+ + + +
+dtor. +
+ +
+Definition at line 577 of file ps_located.h.
+

Member Function Documentation

+ + + + +
+ + + + + + +
+bool NL3D::CPSLocatedBindable::completeBBox ( + +NLMISC::CAABBox & box ) const [inline, virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NL3D::CPSFaceLookAt, and NL3D::CPSFanLight. +
+Definition at line 594 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+CVector NL3D::CPSLocatedBindable::computeI ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Compute a vector that will map to (1 0 0) after view and model transform. +
+This allow to have object that always faces the user, whatever basis they are in +
+Definition at line 708 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+CVector NL3D::CPSLocatedBindable::computeK ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Compute a vector that will map to (0 0 1) after view and model transform. +
+This allow to have object that always faces the user, whatever basis they are in +
+Definition at line 712 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+void NL3D::CPSLocatedBindable::deleteElement ( + +uint32 index ) [protected, pure virtual] +
+
+ + + + + +
+ + + +
+Delete an element given its index Attributes of the located that hold this bindable (pos etc...) are still accessible for of the index given index out of range -> nl_assert. +
+ +
+Reimplemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSGravity, NL3D::CPSSpring, NL3D::CPSParticle, NL3D::CPSDot, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, and NL3D::CPSZonePlane.
+

+ + + + +
+ + + + + + +
+bool NL3D::CPSLocatedBindable::doesProduceBBox ( + +void ) const [inline, virtual] +
+
+ + + + + +
+ + + +
+ +
+Reimplemented in NL3D::CPSForce. +
+Definition at line 600 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+IDriver * NL3D::CPSLocatedBindable::getDriver ( + +) const [inline] +
+
+ + + + + +
+ + + +
+shortcut to get an instance of the driver. +
+ +
+Definition at line 606 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+const CFontGenerator * NL3D::CPSLocatedBindable::getFontGenerator ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Shortcut to get the font generator if one was set (const version). +
+ +
+Definition at line 618 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+CFontGenerator * NL3D::CPSLocatedBindable::getFontGenerator ( + +void ) [inline] +
+
+ + + + + +
+ + + +
+Shortcut to get the font generator if one was set. +
+ +
+Definition at line 611 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+const CFontManager * NL3D::CPSLocatedBindable::getFontManager ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Shortcut to get the font manager if one was set (const version). +
+ +
+Definition at line 632 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+CFontManager * NL3D::CPSLocatedBindable::getFontManager ( + +void ) [inline] +
+
+ + + + + +
+ + + +
+Shortcut to get the font manager if one was set. +
+ +
+Definition at line 625 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+const CMatrix & NL3D::CPSLocatedBindable::getInvertedLocatedMat ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Get the matrix applied to this set of located bindable It may be the identity or the inverted system matrix. +
+ +
+Definition at line 676 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+const CMatrix & NL3D::CPSLocatedBindable::getInvertedSysMat ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+shortcut to get the inverted matrix of the system. +
+ +
+Definition at line 650 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+const CMatrix & NL3D::CPSLocatedBindable::getLocatedMat ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Get the matrix applied to this set of located bindable It may be the identity or the system matrix. +
+ +
+Definition at line 660 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+const CPSLocated * NL3D::CPSLocatedBindable::getOwner ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+get the located that owns this bindable (const version). +
+ +
+Definition at line 719 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+CPSLocated * NL3D::CPSLocatedBindable::getOwner ( + +void ) [inline] +
+
+ + + + + +
+ + + +
+get the located that owns this bindable. +
+ +
+Definition at line 716 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+uint32 NL3D::CPSLocatedBindable::getPriority ( + +void ) const [pure virtual] +
+
+ + + + + +
+ + + +
+Get the priority of the bindable The more high it is, the earlier it is dealt with. +
+ +
+Reimplemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSParticle, and NL3D::CPSZone.
+

+ + + + +
+ + + + + + +
+const CMatrix & NL3D::CPSLocatedBindable::getSysMat ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+Shortcut to get the matrix of the system. +
+ +
+Definition at line 642 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+uint32 NL3D::CPSLocatedBindable::getType ( + +void ) const [pure virtual] +
+
+ + + + + +
+ + + +
+Gives the type for this bindable. +
+types are encoded as constant uint32 +
+Reimplemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSParticle, and NL3D::CPSZone.
+

+ + + + +
+ + + + + + +
+const CMatrix & NL3D::CPSLocatedBindable::getViewMat ( + +void ) const [inline] +
+
+ + + + + +
+ + + +
+shortcut to get the view matrix (trasposed). +
+ +
+Definition at line 691 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+bool NL3D::CPSLocatedBindable::newElement ( + +void ) [protected, 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 in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSGravity, NL3D::CPSSpring, NL3D::CPSParticle, NL3D::CPSDot, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, and NL3D::CPSZonePlane.
+

+ + + + +
+ + + + + + +
+void NL3D::CPSLocatedBindable::resize ( + +uint32 size ) [protected, pure virtual] +
+
+ + + + + +
+ + + +
+Resize the bindable attributes containers. +
+ +
+Reimplemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSGravity, NL3D::CPSSpring, NL3D::CPSParticle, NL3D::CPSDot, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, and NL3D::CPSZonePlane.
+

+ + + + +
+ + + + + + +
+void NL3D::CPSLocatedBindable::serial ( + +NLMISC::IStream & f ) [virtual] +
+
+ + + + + +
+ + + +
+serialization. +
+ +
+Reimplemented from NLMISC::IStreamable. +
+Reimplemented in NL3D::CPSEmitter, NL3D::CPSEmitterOmni, NL3D::CPSForce, NL3D::CPSGravity, NL3D::CPSSpring, NL3D::CPSTargetLocatedBindable, NL3D::CPSParticle, NL3D::CPSDot, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, NL3D::CPSZone, and NL3D::CPSZonePlane. +
+Definition at line 564 of file ps_located.cpp.
+

+ + + + +
+ + + + + + +
+void NL3D::CPSLocatedBindable::setOwner ( + +CPSLocated * psl ) [inline, protected, virtual] +
+
+ + + + + +
+ + + +
+set the located that hold this located bindable. +
+ +
+Definition at line 746 of file ps_located.h.
+

+ + + + +
+ + + + + + +
+void NL3D::CPSLocatedBindable::setupDriverModelMatrix ( + +void ) [inline] +
+
+ + + + + +
+ + + +
+shortcut to setup the model matrix (system basis or world basis). +
+ +
+Definition at line 699 of file ps_located.h.
+

+ + + + +
+ + + + + + + + + + +
+void NL3D::CPSLocatedBindable::step ( + +TPSProcessPass pass, +
+CAnimationTime ellapsedTime ) [pure virtual] +
+
+ + + + + +
+ + + +
+process one pass for this bindable. +
+ +
+Reimplemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSParticle, and NL3D::CPSZone.
+

Member Data Documentation

+ + + + +
+ + + + + +
+CPSLocated * NL3D::CPSLocatedBindable::_Owner [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 751 of file ps_located.h.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CPSLocatedBindable Class Reference

Public Methods

Protected Methods

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation