PixelLightAPI  .
Public Types | Public Member Functions | Protected Member Functions
PLScene::SNMMeshJoint Class Reference

Mesh scene node joint modifier class. More...

#include <SNMMeshJoint.h>

Inheritance diagram for PLScene::SNMMeshJoint:
Inheritance graph
[legend]

List of all members.

Public Types

enum  EFlags { UseFallbackRotation = 1<<2 }
 Flags (SceneNodeModifier flags extension) More...

Public Member Functions

PLS_API const PLMath::Vector3GetRotation () const
PLS_API void SetRotation (const PLMath::Vector3 &vValue)
PLS_API const PLMath::Vector3GetMin () const
PLS_API void SetMin (const PLMath::Vector3 &vValue)
PLS_API const PLMath::Vector3GetMax () const
PLS_API void SetMax (const PLMath::Vector3 &vValue)
PLS_API SNMMeshJoint (SceneNode &cSceneNode)
 Constructor.
virtual PLS_API ~SNMMeshJoint ()
 Destructor.

Protected Member Functions

virtual PLS_API void OnActivate (bool bActivate) override
 Called when the scene node modifier has been activated or deactivated.

Detailed Description

Mesh scene node joint modifier class.

Note:
  • Adds automatically a "PLScene::SNMMeshUpdate" scene node modifier (if there's not yet one) in order to frequently update the mesh
  • If the node has no mesh with a skeleton, this modifier will have no effect

Member Enumeration Documentation

Flags (SceneNodeModifier flags extension)

Enumerator:
UseFallbackRotation 

Use fallback rotation if the target is 'out of rotation range'

Reimplemented from PLScene::SceneNodeModifier.


Constructor & Destructor Documentation

Constructor.

Parameters:
[in]cSceneNodeOwner scene node
virtual PLS_API PLScene::SNMMeshJoint::~SNMMeshJoint ( ) [virtual]

Destructor.


Member Function Documentation

PLS_API void PLScene::SNMMeshJoint::SetRotation ( const PLMath::Vector3 vValue)
PLS_API void PLScene::SNMMeshJoint::SetMin ( const PLMath::Vector3 vValue)
PLS_API void PLScene::SNMMeshJoint::SetMax ( const PLMath::Vector3 vValue)
virtual PLS_API void PLScene::SNMMeshJoint::OnActivate ( bool  bActivate) [override, protected, virtual]

Called when the scene node modifier has been activated or deactivated.

Parameters:
[in]bActivate'true' if the scene node modifier is now active, else 'false'
Note:
  • The scene node "Inactive"-flag as well as the "Frozen"-flag are taken into account
  • 'bActivate' will be 'true' if the scene node modifier AND the owner scene node AND it's parent scene container (recursive!) are active
  • 'bActivate' will be 'false' if the scene node modifier OR the owner scene node OR it's parent scene container (recursive!) is inactive
  • The default implementation is empty

Reimplemented from PLScene::SceneNodeModifier.


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:41
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported