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

UTransformable implementation. +More... +

+#include <transformable_user.h> +

Inheritance diagram for NL3D::CTransformableUser: +

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

Public Methods
Object
	CTransformableUser (ITransformable *trans)
	Give a ITransformable. CTransformableUser DO NOT OWNS IT! More...
virtual	~CTransformableUser ()
Space manipulation
virtual void	setMatrix (const CMatrix &mat)
	Work only in DirecTMatrix mode (nlassert). More...
virtual const CMatrix &	getMatrix () const
	Get the matrix, compute her if necessary (work in all modes). More...
space set/get.
virtual void	setTransformMode (TTransformMode mode, CMatrix::TRotOrder ro=CMatrix::ZXY)
	Change the transform mode. Components or matrix are not reseted. More...
virtual void	setPos (const CVector &pos)
	Work only in Rot mode(nlassert).* More...
virtual void	setRotEuler (const CVector &rot)
	Work only in RotEuler mode(nlassert). More...
virtual void	setRotQuat (const CQuat &quat)
	Work only in RotQuat mode (nlassert). More...
virtual void	setRotQuat (const CVector &jdir)
	Work only in RotQuat mode (nlassert). More...
virtual void	setRotQuat (const CVector &jdir, const CVector &vup)
	Work only in RotQuat mode (nlassert). More...
virtual void	setScale (const CVector &scale)
	Work only in Rot mode (nlassert).* More...
virtual void	setPivot (const CVector &pivot)
	Work only in Rot mode (nlassert).* More...
virtual TTransformMode	getTransformMode ()
	get the current transform mode. More...
virtual CMatrix::TRotOrder	getRotOrder ()
	get the current rotorder (information vlaid only when RotEuler mode). More...
virtual void	getPos (CVector &pos)
	Work only in Rot mode(nlassert).* More...
virtual void	getRotEuler (CVector &rot)
	Work only in RotEuler mode(nlassert). More...
virtual void	getRotQuat (CQuat &quat)
	Work only in RotQuat mode (nlassert). More...
virtual void	getScale (CVector &scale)
	Work only in Rot mode (nlassert).* More...
virtual void	getPivot (CVector &pivot)
	Work only in Rot mode (nlassert).* More...
virtual CVector	getPos ()
	Work only in Rot mode(nlassert).* More...
virtual CVector	getRotEuler ()
	Work only in RotEuler mode(nlassert). More...
virtual CQuat	getRotQuat ()
	Work only in RotQuat mode (nlassert). More...
virtual CVector	getScale ()
	Work only in Rot mode (nlassert).* More...
virtual CVector	getPivot ()
	Work only in Rot mode (nlassert).* More...
Misc
virtual void	lookAt (const CVector &eye, const CVector &target, float roll=0.f)
	Setup Matrix by the lookAt method. More...
Protected Attributes
ITransformable *	_Transformable

Detailed Description

+UTransformable implementation. +

+Author:: +Lionel Berenguier , Nevrax France

+Date:: +2001

+ +

+Definition at line 46 of file transformable_user.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NL3D::CTransformableUser::CTransformableUser ( ITransformable * trans ) [inline]
+
+ + + + + +
+ + + +
+Give a ITransformable. CTransformableUser DO NOT OWNS IT! +
+ +
+Definition at line 58 of file transformable_user.h. +
+References _Transformable, NL3D_MEM_TRANSFORMABLE, and nlassert.
+

+ + + + +
+ + + + + + + + + +
virtual NL3D::CTransformableUser::~CTransformableUser ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 67 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
virtual const CMatrix& NL3D::CTransformableUser::getMatrix ( ) const [inline, virtual]
+
+ + + + + +
+ + + +
+Get the matrix, compute her if necessary (work in all modes). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 81 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual CVector NL3D::CTransformableUser::getPivot ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 195 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::getPivot ( CVector & pivot ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 169 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual CVector NL3D::CTransformableUser::getPos ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode(nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 175 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::getPos ( CVector & pos ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode(nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 149 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual CVector NL3D::CTransformableUser::getRotEuler ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotEuler mode(nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 180 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::getRotEuler ( CVector & rot ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotEuler mode(nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 154 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual CMatrix::TRotOrder NL3D::CTransformableUser::getRotOrder ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+get the current rotorder (information vlaid only when RotEuler mode). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 143 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual CQuat NL3D::CTransformableUser::getRotQuat ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotQuat mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 185 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::getRotQuat ( CQuat & quat ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotQuat mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 159 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual CVector NL3D::CTransformableUser::getScale ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 190 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::getScale ( CVector & scale ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 164 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + +
virtual TTransformMode NL3D::CTransformableUser::getTransformMode ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+get the current transform mode. +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 138 of file transformable_user.h. +
+References _Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::UTransformable::TTransformMode.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CTransformableUser::lookAt ( const CVector & eye,
const CVector & target,
float roll = 0.f
) [inline, virtual]
+
+ + + + + +
+ + + +
+Setup Matrix by the lookAt method. +
+Work only in DirectMatrix mode and RotQuat mode (not euler...).
+Parameters:
+ + + + +
eye +is the coordinate of the object.
target +is the point the object look at.
roll +is the roll angle in radian along the object's Y axis.
+
+
+Implements NL3D::UTransformable. +
+Definition at line 206 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setMatrix ( const CMatrix & mat ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in DirecTMatrix mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 76 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setPivot ( const CVector & pivot ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 132 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setPos ( const CVector & pos ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode(nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 97 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setRotEuler ( const CVector & rot ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotEuler mode(nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 102 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CTransformableUser::setRotQuat ( const CVector & jdir,
const CVector & vup
) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotQuat mode (nlassert). +
+Build a quaternion from a forward direction (a J vector). the roll is determined with help of the vector up vup... vectors do not need to be noramlized. +
+Implements NL3D::UTransformable. +
+Definition at line 120 of file transformable_user.h. +
+References NL3D_MEM_TRANSFORMABLE, and setRotQuat.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setRotQuat ( const CVector & jdir ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotQuat mode (nlassert). +
+Build a quaternion from a forward direction (a J vector). there is no roll... jdir do not need to be noramlized. +
+Implements NL3D::UTransformable. +
+Definition at line 112 of file transformable_user.h. +
+References NL3D_MEM_TRANSFORMABLE, and setRotQuat.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setRotQuat ( const CQuat & quat ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in RotQuat mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 107 of file transformable_user.h. +
+References _Transformable, and NL3D_MEM_TRANSFORMABLE. +
+Referenced by setRotQuat.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CTransformableUser::setScale ( const CVector & scale ) [inline, virtual]
+
+ + + + + +
+ + + +
+Work only in Rot* mode (nlassert). +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 128 of file transformable_user.h. +
+References _Transformable.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CTransformableUser::setTransformMode ( TTransformMode mode,
CMatrix::TRotOrder ro = CMatrix::ZXY
) [inline, virtual]
+
+ + + + + +
+ + + +
+Change the transform mode. Components or matrix are not reseted. +
+ +
+Implements NL3D::UTransformable. +
+Definition at line 92 of file transformable_user.h. +
+References _Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::UTransformable::TTransformMode.
+

Member Data Documentation

+ + + + +
+ + +
ITransformable* NL3D::CTransformableUser::_Transformable [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file transformable_user.h. +
+Referenced by CTransformableUser, getMatrix, getPivot, getPos, getRotEuler, getRotOrder, getRotQuat, getScale, getTransformMode, lookAt, setMatrix, setPivot, setPos, setRotEuler, setRotQuat, setScale, setTransformMode, and ~CTransformableUser.
+

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

transformable_user.h

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CTransformableUser Class Reference

Public Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation