NL3D::CTransformUser Class Reference

#include <transform_user.h>

Inheritance diagram for NL3D::CTransformUser:

NL3D::UTransform NL3D::CTransformableUser NL3D::UTransformable NL3D::UTransformable NL3D::CCameraUser NL3D::CInstanceUser NL3D::CParticleSystemInstanceUser NL3D::CPointLightUser NL3D::CSkeletonUser NL3D::CWaterInstanceUser

Detailed Description

UTransform implementation.
Author:
Lionel Berenguier

Nevrax France

Date:
2001

Definition at line 51 of file transform_user.h.

Public Types

enum  TTransformMode { DirectMatrix = 0, RotEuler, RotQuat, TransformModeCount }
enum  TVisibility { Show = 0, Hide, Herit, VisibilityCount }
 The visibility flag. In the root case, Herit means Show. More...


Public Member Functions

virtual bool getForceClipRoot () const
virtual bool getLastClippedState () const
 Return true if the object was rendered during the last Scene->rendere(). return false else (ie clipped).

virtual void getLastParentClusters (std::vector< CCluster * > &clusters) const
 Fill a list of cluster that contain this tranform. This is valid after the clip traversal.

virtual const CMatrixgetLastWorldMatrixComputed () const
virtual bool getLastWorldVisState () const
 Return true if the object was determined as Visible in Hrc during the last Scene->rendere(). NB: interesting only if Herit. else can use getVisibility().

virtual uint getOrderingLayer () const
 Get the ordering layer.

virtual void setForceClipRoot (bool forceClipRoot)
virtual void setLogicInfo (ILogicInfo *logicInfo)
virtual void setOrderingLayer (uint layer)
Object
 CTransformUser (CScene *scene, CTransform *trans, bool deleteIt)
virtual ~CTransformUser ()

Protected Attributes

bool _DeleteIt
CScene_Scene
CTransform_Transform
ITransformable_Transformable


Member Enumeration Documentation

enum NL3D::UTransformable::TTransformMode [inherited]
 

Enumeration values:
DirectMatrix 
RotEuler 
RotQuat 
TransformModeCount 

Definition at line 66 of file u_transformable.h.

00067         {
00068                 DirectMatrix=0,         // DirectMatrixMode .
00069                 RotEuler,                       // Matrix is computed from sperated composantes, with euler rotation.
00070                 RotQuat,                        // Matrix is computed from sperated composantes, with quat rotation (default).
00071 
00072                 TransformModeCount
00073         };

enum NL3D::UTransform::TVisibility [inherited]
 

The visibility flag. In the root case, Herit means Show.

Enumeration values:
Show 
Hide 
Herit 
VisibilityCount 

Definition at line 68 of file u_transform.h.

00069         {
00070                 Show=0,         // The model is shown in the hierarchy
00071                 Hide,           // The model is hidden in the hierarchy
00072                 Herit,          // The model herit the visibilty from his father
00073 
00074                 VisibilityCount
00075         };


Constructor & Destructor Documentation

NL3D::CTransformUser::CTransformUser CScene scene,
CTransform trans,
bool  deleteIt
[inline]
 

Give a Scene Instance. CTransformUser owns it, and will delete it.

Parameters:
deleteIt is true if the CTransformUser must delete the transform shape in the destructor, else false.

Definition at line 69 of file transform_user.h.

References _DeleteIt, _Transform, NL3D_MEM_TRANSFORM, nlassert, and uint.

00069                                                                         : CTransformableUser( static_cast<ITransformable*>((CTransform*)trans) )
00070         {
00071                 NL3D_MEM_TRANSFORM
00072                 nlassert(trans);
00073                 _Scene= scene;
00074                 _DeleteIt = deleteIt;
00075                 // NB: _Transform is "same" pointer as ITransformable, but correclty casted.
00076                 _Transform= NLMISC::safe_cast<CTransform*>(trans);
00077                 // Same enums!!
00078                 nlassert((uint)UTransform::VisibilityCount == (uint)CHrcTrav::VisibilityCount);
00079         }

virtual NL3D::CTransformUser::~CTransformUser  )  [inline, virtual]
 

Give a Scene Instance. CTransformUser owns it, and will delete it.

Parameters:
deleteIt is true if the CTransformUser must delete the transform shape in the destructor, else false.

Definition at line 80 of file transform_user.h.

References _DeleteIt, _Transform, NL3D::CScene::deleteInstance(), NL3D::CScene::deleteModel(), NL3D_MEM_TRANSFORM, and nlassert.

00081         {
00082                 NL3D_MEM_TRANSFORM
00083                 if (_Transform && _DeleteIt)
00084                 {
00085                         // Scene must not be NULL if _DeleteIt == true
00086                         nlassert (_Scene);
00087 
00088                         // Must test if _Transform is a CTransfromShape. If yes, must call deleteInstance().
00089                         CTransformShape *pTrShp= dynamic_cast<CTransformShape*>(_Transform);
00090                         if(pTrShp)
00091                                 _Scene->deleteInstance(pTrShp);
00092                         else
00093                                 _Scene->deleteModel(_Transform);
00094                         _Transform= NULL;
00095                 }
00096         }


Member Function Documentation

virtual bool NL3D::CTransformUser::canCastShadowMap  )  const [virtual]
 

true if the instance cast shadow. By default false

Implements NL3D::UTransform.

virtual bool NL3D::CTransformUser::canReceiveShadowMap  )  const [virtual]
 

true if the instance receive shadow. By default false

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::enableCastShadowMap bool  state  )  [virtual]
 

By default, map shadow casting is disabled. This enabled shadow for this model. Fails if the model don't support dynamic Map Shadow Casting (eg landscape)

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::enableReceiveShadowMap bool  state  )  [virtual]
 

By default, map shadow receiving is disabled. This enabled shadow for this model. Fails if the model don't support dynamic Map Shadow Receiving (eg Particle system)

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::freezeHRC  )  [virtual]
 

Optimisation: freeze the HRC so the WorldMatrix computed at next render() will be kept for long, and the model won't either be tested in HRC.

NB: the model won't be tested in HRC only if this model is a "root" For maximum optimisation, you should freezeHRC() all the models of a hierarchy, from base root to leaves.

NB: if the hierarchy of this object must change, or if the object must moves, you must call unfreezeHRC() first, and you should do this for all the parents of this model.

Implements NL3D::UTransform.

virtual UInstanceGroup* NL3D::CTransformUser::getClusterSystem  )  [virtual]
 

Implements NL3D::UTransform.

virtual bool NL3D::CTransformUser::getForceClipRoot  )  const [inline, virtual]
 

Implements NL3D::UTransform.

Definition at line 265 of file transform_user.h.

References _Transform, NL3D::CTransform::getForceClipRoot(), and NL3D_MEM_TRANSFORM.

00266         {
00267                 NL3D_MEM_TRANSFORM
00268                 return _Transform->getForceClipRoot();
00269         }

virtual bool NL3D::CTransformUser::getLastClippedState  )  const [inline, virtual]
 

Return true if the object was rendered during the last Scene->rendere(). return false else (ie clipped).

Implements NL3D::UTransform.

Definition at line 204 of file transform_user.h.

References _Transform, NL3D::CTransform::isClipVisible(), and NL3D_MEM_TRANSFORM.

00205         {
00206                 NL3D_MEM_TRANSFORM
00207                 return _Transform->isClipVisible();
00208         }

virtual void NL3D::CTransformUser::getLastParentClusters std::vector< CCluster * > &  clusters  )  const [virtual]
 

Fill a list of cluster that contain this tranform. This is valid after the clip traversal.

Implements NL3D::UTransform.

virtual const CMatrix& NL3D::CTransformUser::getLastWorldMatrixComputed  )  const [virtual]
 

get the last world matrix computed in last render(). NB: this WM is computed in last render() only if the object was not clipped. So use it wisely. use getLastClippedState() to konw if the object was visible in last render().

Implements NL3D::UTransform.

virtual bool NL3D::CTransformUser::getLastWorldVisState  )  const [inline, virtual]
 

Return true if the object was determined as Visible in Hrc during the last Scene->rendere(). NB: interesting only if Herit. else can use getVisibility().

Implements NL3D::UTransform.

Definition at line 198 of file transform_user.h.

References _Transform, NL3D::CTransform::isHrcVisible(), and NL3D_MEM_TRANSFORM.

00199         {
00200                 NL3D_MEM_TRANSFORM
00201                 return _Transform->isHrcVisible();
00202         }

virtual const std::string& NL3D::CTransformUser::getLoadBalancingGroup  )  const [virtual]
 

Get the load Balancing group of a model. see setLoadBalancingGroup().

Implements NL3D::UTransform.

virtual const CMatrix& NL3D::CTransformableUser::getMatrix  )  const [inline, virtual, inherited]
 

Get the matrix, compute her if necessary (work in all modes).

Implements NL3D::UTransformable.

Definition at line 81 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getMatrix(), and NL3D_MEM_TRANSFORMABLE.

00082         {
00083                 NL3D_MEM_TRANSFORMABLE
00084                 return _Transformable->getMatrix();
00085         }

virtual const CMatrix& NL3D::UTransformable::getMatrix  )  const [pure virtual, inherited]
 

Get the matrix, compute her if necessary (work in all modes).

Implemented in NL3D::CTransformableUser.

Referenced by NL3D::CDriverUser::setMatrixMode3D().

virtual NLMISC::CRGBA NL3D::CTransformUser::getMeanColor  )  const [virtual]
 

see setMeanColor()

Implements NL3D::UTransform.

virtual uint NL3D::CTransformUser::getOrderingLayer  )  const [inline, virtual]
 

Get the ordering layer.

Implements NL3D::UTransform.

Definition at line 169 of file transform_user.h.

References _Transform, NL3D::CTransform::getOrderingLayer(), NL3D_MEM_TRANSFORM, and uint.

00170         { 
00171                 NL3D_MEM_TRANSFORM
00172                 return _Transform->getOrderingLayer(); 
00173         }

virtual CVector NL3D::CTransformableUser::getPivot  )  [inline, virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 195 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getPivot(), and NL3D_MEM_TRANSFORMABLE.

00196         {
00197                 NL3D_MEM_TRANSFORMABLE
00198                 return _Transformable->getPivot();
00199         }

virtual void NL3D::CTransformableUser::getPivot CVector pivot  )  [inline, virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 169 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getPivot(), and NL3D_MEM_TRANSFORMABLE.

00170         {
00171                 NL3D_MEM_TRANSFORMABLE
00172                 _Transformable->getPivot(pivot);
00173         }

virtual CVector NL3D::UTransformable::getPivot  )  [pure virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::getPivot CVector pivot  )  [pure virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implemented in NL3D::CTransformableUser.

const char * NL3D::UTransformable::getPivotValueName  )  [static, inherited]
 

Definition at line 55 of file transformable_user.cpp.

References NL3D_MEM_TRANSFORMABLE.

00056 {
00057         NL3D_MEM_TRANSFORMABLE
00058         return ITransformable::getPivotValueName();
00059 }

virtual CVector NL3D::CTransformableUser::getPos  )  [inline, virtual, inherited]
 

Work only in Rot* mode(nlassert).

Implements NL3D::UTransformable.

Definition at line 175 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getPos(), and NL3D_MEM_TRANSFORMABLE.

Referenced by NL3D::CInstanceUser::startAsyncTextureLoading().

00176         {
00177                 NL3D_MEM_TRANSFORMABLE
00178                 return _Transformable->getPos();
00179         }

virtual void NL3D::CTransformableUser::getPos CVector pos  )  [inline, virtual, inherited]
 

Work only in Rot* mode(nlassert).

Implements NL3D::UTransformable.

Definition at line 149 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getPos(), and NL3D_MEM_TRANSFORMABLE.

00150         {
00151                 NL3D_MEM_TRANSFORMABLE
00152                 _Transformable->getPos(pos);
00153         }

virtual CVector NL3D::UTransformable::getPos  )  [pure virtual, inherited]
 

Work only in Rot* mode(nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::getPos CVector pos  )  [pure virtual, inherited]
 

Work only in Rot* mode(nlassert).

Implemented in NL3D::CTransformableUser.

const char * NL3D::UTransformable::getPosValueName  )  [static, inherited]
 

Definition at line 35 of file transformable_user.cpp.

References NL3D_MEM_TRANSFORMABLE.

00036 {
00037         NL3D_MEM_TRANSFORMABLE
00038         return ITransformable::getPosValueName ();
00039 }

virtual CVector NL3D::CTransformableUser::getRotEuler  )  [inline, virtual, inherited]
 

Work only in RotEuler mode(nlassert).

Implements NL3D::UTransformable.

Definition at line 180 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getRotEuler(), and NL3D_MEM_TRANSFORMABLE.

00181         {
00182                 NL3D_MEM_TRANSFORMABLE
00183                 return _Transformable->getRotEuler();
00184         }

virtual void NL3D::CTransformableUser::getRotEuler CVector rot  )  [inline, virtual, inherited]
 

Work only in RotEuler mode(nlassert).

Implements NL3D::UTransformable.

Definition at line 154 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getRotEuler(), and NL3D_MEM_TRANSFORMABLE.

00155         {
00156                 NL3D_MEM_TRANSFORMABLE
00157                 _Transformable->getRotEuler(rot);
00158         }

virtual CVector NL3D::UTransformable::getRotEuler  )  [pure virtual, inherited]
 

Work only in RotEuler mode(nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::getRotEuler CVector rot  )  [pure virtual, inherited]
 

Work only in RotEuler mode(nlassert).

Implemented in NL3D::CTransformableUser.

const char * NL3D::UTransformable::getRotEulerValueName  )  [static, inherited]
 

Definition at line 40 of file transformable_user.cpp.

References NL3D_MEM_TRANSFORMABLE.

00041 {
00042         NL3D_MEM_TRANSFORMABLE
00043         return ITransformable::getRotEulerValueName();
00044 }

virtual CMatrix::TRotOrder NL3D::CTransformableUser::getRotOrder  )  [inline, virtual, inherited]
 

get the current rotorder (information vlaid only when RotEuler mode).

Implements NL3D::UTransformable.

Definition at line 143 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getRotOrder(), and NL3D_MEM_TRANSFORMABLE.

00144         {
00145                 NL3D_MEM_TRANSFORMABLE
00146                 return _Transformable->getRotOrder();
00147         }

virtual CMatrix::TRotOrder NL3D::UTransformable::getRotOrder  )  [pure virtual, inherited]
 

get the current rotorder (information vlaid only when RotEuler mode).

Implemented in NL3D::CTransformableUser.

virtual CQuat NL3D::CTransformableUser::getRotQuat  )  [inline, virtual, inherited]
 

Work only in RotQuat mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 185 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getRotQuat(), and NL3D_MEM_TRANSFORMABLE.

00186         {
00187                 NL3D_MEM_TRANSFORMABLE
00188                 return _Transformable->getRotQuat();
00189         }

virtual void NL3D::CTransformableUser::getRotQuat CQuat quat  )  [inline, virtual, inherited]
 

Work only in RotQuat mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 159 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getRotQuat(), and NL3D_MEM_TRANSFORMABLE.

00160         {
00161                 NL3D_MEM_TRANSFORMABLE
00162                 _Transformable->getRotQuat(quat);
00163         }

virtual CQuat NL3D::UTransformable::getRotQuat  )  [pure virtual, inherited]
 

Work only in RotQuat mode (nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::getRotQuat CQuat quat  )  [pure virtual, inherited]
 

Work only in RotQuat mode (nlassert).

Implemented in NL3D::CTransformableUser.

const char * NL3D::UTransformable::getRotQuatValueName  )  [static, inherited]
 

Definition at line 45 of file transformable_user.cpp.

References NL3D_MEM_TRANSFORMABLE.

00046 {
00047         NL3D_MEM_TRANSFORMABLE
00048         return ITransformable::getRotQuatValueName();
00049 }

virtual CVector NL3D::CTransformableUser::getScale  )  [inline, virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 190 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getScale(), and NL3D_MEM_TRANSFORMABLE.

00191         {
00192                 NL3D_MEM_TRANSFORMABLE
00193                 return _Transformable->getScale();
00194         }

virtual void NL3D::CTransformableUser::getScale CVector scale  )  [inline, virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 164 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getScale(), and NL3D_MEM_TRANSFORMABLE.

00165         {
00166                 NL3D_MEM_TRANSFORMABLE
00167                 _Transformable->getScale(scale);
00168         }

virtual CVector NL3D::UTransformable::getScale  )  [pure virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::getScale CVector scale  )  [pure virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implemented in NL3D::CTransformableUser.

const char * NL3D::UTransformable::getScaleValueName  )  [static, inherited]
 

Definition at line 50 of file transformable_user.cpp.

References NL3D_MEM_TRANSFORMABLE.

00051 {
00052         NL3D_MEM_TRANSFORMABLE
00053         return ITransformable::getScaleValueName();
00054 }

CScene* NL3D::CTransformUser::getScene void   )  [inline]
 

Definition at line 274 of file transform_user.h.

References NL3D_MEM_TRANSFORM.

Referenced by NL3D::CSceneUser::setCam().

00275         {
00276                 NL3D_MEM_TRANSFORM
00277                 return _Scene;
00278         }

CTransform* NL3D::CTransformUser::getTransform  )  [inline]
 

Definition at line 279 of file transform_user.h.

References _Transform, and NL3D_MEM_TRANSFORM.

Referenced by NL3D::CPlayListUser::registerTransform().

00280         {
00281                 NL3D_MEM_TRANSFORM
00282                 return _Transform;
00283         }

virtual TTransformMode NL3D::CTransformableUser::getTransformMode  )  [inline, virtual, inherited]
 

get the current transform mode.

Implements NL3D::UTransformable.

Definition at line 138 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::getTransformMode(), NL3D_MEM_TRANSFORMABLE, and uint.

00139         {
00140                 NL3D_MEM_TRANSFORMABLE
00141                 return (TTransformMode)(uint)_Transformable->getTransformMode();
00142         }

virtual TTransformMode NL3D::UTransformable::getTransformMode  )  [pure virtual, inherited]
 

get the current transform mode.

Implemented in NL3D::CTransformableUser.

virtual bool NL3D::CTransformUser::getUserClipping  )  const [inline, virtual]
 

Return the user clipping state.

Implements NL3D::UTransform.

Definition at line 132 of file transform_user.h.

References _Transform, NL3D::CTransform::getUserClipping(), NL3D_MEM_TRANSFORM, and nlassert.

00133         {
00134                 NL3D_MEM_TRANSFORM
00135                 nlassert(_Transform) ; // object invalid now ...
00136                 return _Transform->getUserClipping();
00137         }

virtual bool NL3D::CTransformUser::getUserLightable  )  const [inline, virtual]
 

Get the UserLightable flag.

Implements NL3D::UTransform.

Definition at line 183 of file transform_user.h.

References _Transform, NL3D::CTransform::getUserLightable(), and NL3D_MEM_TRANSFORM.

00184         {
00185                 NL3D_MEM_TRANSFORM
00186                 return  _Transform->getUserLightable();
00187         }

virtual TVisibility NL3D::CTransformUser::getVisibility  )  [inline, virtual]
 

Get the local visibility state.

Implements NL3D::UTransform.

Definition at line 146 of file transform_user.h.

References _Transform, NL3D::CTransform::getVisibility(), NL3D_MEM_TRANSFORM, nlassert, and uint32.

00147         {
00148                 NL3D_MEM_TRANSFORM
00149                 nlassert(_Transform) ; // object invalid now ...
00150                 return (UTransform::TVisibility)(uint32)_Transform->getVisibility();
00151         }

virtual void NL3D::CTransformUser::heritVisibility  )  [inline, virtual]
 

herit the visibility from his father. (default behavior).

Implements NL3D::UTransform.

Definition at line 139 of file transform_user.h.

References _Transform, NL3D::CTransform::heritVisibility(), NL3D_MEM_TRANSFORM, and nlassert.

00140         {
00141                 NL3D_MEM_TRANSFORM
00142                 nlassert(_Transform) ; // object invalid now ...
00143                 _Transform->heritVisibility();
00144         }

virtual void NL3D::CTransformUser::hide  )  [inline, virtual]
 

Hide the object and his sons.

Implements NL3D::UTransform.

Definition at line 113 of file transform_user.h.

References _Transform, NL3D::CTransform::hide(), NL3D_MEM_TRANSFORM, and nlassert.

00114         {
00115                 NL3D_MEM_TRANSFORM
00116                 nlassert(_Transform) ; // object invalid now ...
00117                 _Transform->hide();
00118         }

virtual uint32 NL3D::CTransformUser::isOpaque  )  [inline, virtual]
 

Implements NL3D::UTransform.

Definition at line 239 of file transform_user.h.

References _Transform, NL3D::CTransform::isOpaque(), NL3D_MEM_TRANSFORM, and uint32.

00240         {
00241                 NL3D_MEM_TRANSFORM
00242                 return _Transform->isOpaque();
00243         }

virtual uint32 NL3D::CTransformUser::isTransparent  )  [inline, virtual]
 

Implements NL3D::UTransform.

Definition at line 244 of file transform_user.h.

References _Transform, NL3D::CTransform::isTransparent(), NL3D_MEM_TRANSFORM, and uint32.

00245         {
00246                 NL3D_MEM_TRANSFORM
00247                 return _Transform->isTransparent();
00248         }

virtual void NL3D::CTransformableUser::lookAt const CVector eye,
const CVector target,
float  roll = 0.f
[inline, virtual, inherited]
 

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 NL3D::CTransformableUser::_Transformable, NL3D::ITransformable::lookAt(), and NL3D_MEM_TRANSFORMABLE.

00207         {
00208                 NL3D_MEM_TRANSFORMABLE
00209                 _Transformable->lookAt(eye, target, roll);
00210         }

virtual void NL3D::UTransformable::lookAt const CVector eye,
const CVector target,
float  roll = 0.f
[pure virtual, inherited]
 

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.

Implemented in NL3D::CTransformableUser.

virtual void NL3D::CTransformUser::parent UTransform newFather  )  [virtual]
 

unlink this from oldparent, and make this be a son of newFather.

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::setClusterSystem UInstanceGroup pIG  )  [virtual]
 

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::setForceClipRoot bool  forceClipRoot  )  [inline, virtual]
 

Force the transform to always be attached to the root As a consequence, it can't be inserted into a cluster system (even the root cluster) and is thus always visible when in the frustum (not clusterized) NB : any call to setClusterSystem will be ignored (must remain unclesterized) NB : any call to parent will be ignored (must remain linked to the root)

Implements NL3D::UTransform.

Definition at line 259 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, and NL3D::CTransform::setForceClipRoot().

00260         {
00261                 NL3D_MEM_TRANSFORM
00262                 _Transform->setForceClipRoot(forceClipRoot);
00263         }

virtual void NL3D::CTransformUser::setLoadBalancingGroup const std::string &  group  )  [virtual]
 

Change the load Balancing group of a model. Every models are in a special LoadBalancingGroup. NB: the group is created if did not exist. NB: if models are skinned, it is their Skeleton which drive the group

By default, models lies in the "Default" group, but Skeletons for skinning and ParticlesSystems which are in "Skin" and "Fx" group respectively. The "Default" group is special because it is not balanced (ie models are only degraded from their distance to camera)

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::setLogicInfo ILogicInfo logicInfo  )  [inline, virtual]
 

Set the LogicInfo for this transfrom, eg to retrieve statc light information, see ILogicInfo. Ptr is kept in UTransfrom, so should call setLogicInfo(NULL) before to clean up.

Implements NL3D::UTransform.

Definition at line 191 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, and NL3D::CTransform::setLogicInfo().

00192         {
00193                 NL3D_MEM_TRANSFORM
00194                 _Transform->setLogicInfo(logicInfo);
00195         }

virtual void NL3D::CTransformableUser::setMatrix const CMatrix mat  )  [inline, virtual, inherited]
 

Work only in DirecTMatrix mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 76 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::ITransformable::setMatrix().

00077         {
00078                 NL3D_MEM_TRANSFORMABLE
00079                 _Transformable->setMatrix(mat);
00080         }

virtual void NL3D::UTransformable::setMatrix const CMatrix mat  )  [pure virtual, inherited]
 

Work only in DirecTMatrix mode (nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::CTransformUser::setMeanColor NLMISC::CRGBA  color  )  [virtual]
 

set the Mean color of the transform. The mean color can be used for many purpose, such as drawing objects if the textures are not loaded. It is used also for Lod Character. Default color is (255,255,255)

Implements NL3D::UTransform.

virtual void NL3D::CTransformUser::setOpacity bool  v  )  [inline, virtual]
 

Implements NL3D::UTransform.

Definition at line 234 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, NL3D::CTransform::setOpacity(), and v.

00235         {
00236                 NL3D_MEM_TRANSFORM
00237                 _Transform->setOpacity(true);
00238         }

virtual void NL3D::CTransformUser::setOrderingLayer uint  layer  )  [inline, virtual]
 

Set the current ordering layer for this transform. Typically, this is used to sort transparent objects. Isn't used with solid objects. For now : Layer 0 is for underwater Layer 1 is for water surfaces Layer 2 is for object above water

Implements NL3D::UTransform.

Definition at line 162 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, NL3D::CTransform::setOrderingLayer(), and uint.

00163         { 
00164                 NL3D_MEM_TRANSFORM
00165                 _Transform->setOrderingLayer(layer); 
00166         }

virtual void NL3D::CTransformableUser::setPivot const CVector pivot  )  [inline, virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 132 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::ITransformable::setPivot().

00133         {
00134                 NL3D_MEM_TRANSFORMABLE
00135                 _Transformable->setPivot(pivot);
00136         }

void NL3D::UTransformable::setPivot float  px,
float  py,
float  pz
[inline, inherited]
 

Work only in Rot* mode (nlassert).

Definition at line 108 of file u_transformable.h.

References NL3D::UTransformable::setPivot().

00108 {setPivot(CVector(px, py, pz));}

virtual void NL3D::UTransformable::setPivot const CVector pivot  )  [pure virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implemented in NL3D::CTransformableUser.

Referenced by NL3D::UTransformable::setPivot().

virtual void NL3D::CTransformableUser::setPos const CVector pos  )  [inline, virtual, inherited]
 

Work only in Rot* mode(nlassert).

Implements NL3D::UTransformable.

Definition at line 97 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::ITransformable::setPos().

00098         {
00099                 NL3D_MEM_TRANSFORMABLE
00100                 _Transformable->setPos(pos);
00101         }

void NL3D::UTransformable::setPos float  px,
float  py,
float  pz
[inline, inherited]
 

Work only in Rot* mode(nlassert).

Definition at line 86 of file u_transformable.h.

References NL3D::UTransformable::setPos().

00086 {setPos(CVector(px, py, pz));}

virtual void NL3D::UTransformable::setPos const CVector pos  )  [pure virtual, inherited]
 

Work only in Rot* mode(nlassert).

Implemented in NL3D::CTransformableUser.

Referenced by NL3D::UTransformable::setPos().

virtual void NL3D::CTransformableUser::setRotEuler const CVector rot  )  [inline, virtual, inherited]
 

Work only in RotEuler mode(nlassert).

Implements NL3D::UTransformable.

Definition at line 102 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::ITransformable::setRotEuler().

00103         {
00104                 NL3D_MEM_TRANSFORMABLE
00105                 _Transformable->setRotEuler(rot);
00106         }

void NL3D::UTransformable::setRotEuler float  rx,
float  ry,
float  rz
[inline, inherited]
 

Work only in RotEuler mode(nlassert).

Definition at line 90 of file u_transformable.h.

References NL3D::UTransformable::setRotEuler().

00090 {setRotEuler(CVector(rx, ry, rz));}

virtual void NL3D::UTransformable::setRotEuler const CVector rot  )  [pure virtual, inherited]
 

Work only in RotEuler mode(nlassert).

Implemented in NL3D::CTransformableUser.

Referenced by NL3D::UTransformable::setRotEuler().

virtual void NL3D::CTransformableUser::setRotQuat const CVector jdir,
const CVector vup
[inline, virtual, inherited]
 

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 NL3D::CTransformableUser::setRotQuat().

00121         {
00122                 NL3D_MEM_TRANSFORMABLE
00123                 CMatrix mat;
00124                 mat.setRot(CVector::I, jdir, vup);
00125                 mat.normalize(CMatrix::YZX);
00126                 setRotQuat(mat.getRot());
00127         }

virtual void NL3D::CTransformableUser::setRotQuat const CVector jdir  )  [inline, virtual, inherited]
 

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 NL3D::CTransformableUser::setRotQuat().

00113         {
00114                 NL3D_MEM_TRANSFORMABLE
00115                 CMatrix mat;
00116                 mat.setRot(CVector::I, jdir, CVector::K);
00117                 mat.normalize(CMatrix::YZX);
00118                 setRotQuat(mat.getRot());
00119         }

virtual void NL3D::CTransformableUser::setRotQuat const CQuat quat  )  [inline, virtual, inherited]
 

Work only in RotQuat mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 107 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D_MEM_TRANSFORMABLE, and NL3D::ITransformable::setRotQuat().

Referenced by NL3D::CTransformableUser::setRotQuat().

00108         {
00109                 NL3D_MEM_TRANSFORMABLE
00110                 _Transformable->setRotQuat(quat);
00111         }

virtual void NL3D::UTransformable::setRotQuat const CVector jdir,
const CVector vup
[pure virtual, inherited]
 

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.

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::setRotQuat const CVector jdir  )  [pure virtual, inherited]
 

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.

Implemented in NL3D::CTransformableUser.

virtual void NL3D::UTransformable::setRotQuat const CQuat quat  )  [pure virtual, inherited]
 

Work only in RotQuat mode (nlassert).

Implemented in NL3D::CTransformableUser.

virtual void NL3D::CTransformableUser::setScale const CVector scale  )  [inline, virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implements NL3D::UTransformable.

Definition at line 128 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, and NL3D::ITransformable::setScale().

00129         {
00130                 _Transformable->setScale(scale);
00131         }

void NL3D::UTransformable::setScale float  sx,
float  sy,
float  sz
[inline, inherited]
 

Work only in Rot* mode (nlassert).

Definition at line 104 of file u_transformable.h.

References NL3D::UTransformable::setScale().

00104 {setScale(CVector(sx, sy, sz));}

virtual void NL3D::UTransformable::setScale const CVector scale  )  [pure virtual, inherited]
 

Work only in Rot* mode (nlassert).

Implemented in NL3D::CTransformableUser.

Referenced by NL3D::UTransformable::setScale().

virtual void NL3D::CTransformableUser::setTransformMode TTransformMode  mode,
CMatrix::TRotOrder  ro = CMatrix::ZXY
[inline, virtual, inherited]
 

Change the transform mode. Components or matrix are not reseted.

Implements NL3D::UTransformable.

Definition at line 92 of file transformable_user.h.

References NL3D::CTransformableUser::_Transformable, NL3D_MEM_TRANSFORMABLE, NL3D::ITransformable::setTransformMode(), and uint.

00093         {
00094                 NL3D_MEM_TRANSFORMABLE
00095                 _Transformable->setTransformMode((ITransformable::TTransformMode)(uint)mode, ro);
00096         }

virtual void NL3D::UTransformable::setTransformMode TTransformMode  mode,
CMatrix::TRotOrder  ro = CMatrix::ZXY
[pure virtual, inherited]
 

Change the transform mode. Components or matrix are not reseted.

Implemented in NL3D::CTransformableUser.

virtual void NL3D::CTransformUser::setTransparency bool  v  )  [inline, virtual]
 

Implements NL3D::UTransform.

Definition at line 229 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, NL3D::CTransform::setTransparency(), and v.

00230         {
00231                 NL3D_MEM_TRANSFORM
00232                 _Transform->setTransparency(v);
00233         }

virtual void NL3D::CTransformUser::setUserClipping bool  enable  )  [inline, virtual]
 

Return the user clipping state.

Implements NL3D::UTransform.

Definition at line 126 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, nlassert, and NL3D::CTransform::setUserClipping().

00127         {
00128                 NL3D_MEM_TRANSFORM
00129                 nlassert(_Transform) ; // object invalid now ...
00130                 _Transform->setUserClipping(enable);
00131         }

virtual void NL3D::CTransformUser::setUserLightable bool  enable  )  [inline, virtual]
 

Set the UserLightable flag. if false, isLightable() will always return false. Doing this, user can disable lighting on a model which may be interesting for speed. NB: most of models don't need it. For example models with LightMaps are by default Lighing-disabled. Default behavior is UserLightable==true.

Implements NL3D::UTransform.

Definition at line 178 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, and NL3D::CTransform::setUserLightable().

00179         {
00180                 NL3D_MEM_TRANSFORM
00181                 _Transform->setUserLightable(enable);
00182         }

virtual void NL3D::CTransformUser::show  )  [inline, virtual]
 

Show the objet and his sons.

Implements NL3D::UTransform.

Definition at line 120 of file transform_user.h.

References _Transform, NL3D_MEM_TRANSFORM, nlassert, and NL3D::CTransform::show().

00121         {
00122                 NL3D_MEM_TRANSFORM
00123                 nlassert(_Transform) ; // object invalid now ...
00124                 _Transform->show();
00125         }

virtual void NL3D::CTransformUser::unfreezeHRC  )  [virtual]
 

see freezeHRC().

Implements NL3D::UTransform.


Field Documentation

bool NL3D::CTransformUser::_DeleteIt [protected]
 

Definition at line 60 of file transform_user.h.

Referenced by CTransformUser(), and ~CTransformUser().

CScene* NL3D::CTransformUser::_Scene [protected]
 

Definition at line 55 of file transform_user.h.

CTransform* NL3D::CTransformUser::_Transform [protected]
 

Definition at line 57 of file transform_user.h.

Referenced by CTransformUser(), getForceClipRoot(), getLastClippedState(), getLastWorldVisState(), getOrderingLayer(), getTransform(), getUserClipping(), getUserLightable(), getVisibility(), heritVisibility(), hide(), isOpaque(), isTransparent(), setForceClipRoot(), setLogicInfo(), setOpacity(), setOrderingLayer(), setTransparency(), setUserClipping(), setUserLightable(), show(), and ~CTransformUser().

ITransformable* NL3D::CTransformableUser::_Transformable [protected, inherited]
 

Definition at line 50 of file transformable_user.h.

Referenced by NL3D::CTransformableUser::CTransformableUser(), NL3D::CTransformableUser::getMatrix(), NL3D::CTransformableUser::getPivot(), NL3D::CTransformableUser::getPos(), NL3D::CTransformableUser::getRotEuler(), NL3D::CTransformableUser::getRotOrder(), NL3D::CTransformableUser::getRotQuat(), NL3D::CTransformableUser::getScale(), NL3D::CTransformableUser::getTransformMode(), NL3D::CTransformableUser::lookAt(), NL3D::CTransformableUser::setMatrix(), NL3D::CTransformableUser::setPivot(), NL3D::CTransformableUser::setPos(), NL3D::CTransformableUser::setRotEuler(), NL3D::CTransformableUser::setRotQuat(), NL3D::CTransformableUser::setScale(), NL3D::CTransformableUser::setTransformMode(), and NL3D::CTransformableUser::~CTransformableUser().


The documentation for this class was generated from the following file:
Generated on Tue Mar 16 08:18:40 2004 for NeL by doxygen 1.3.6