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

Scene node anchor modifier class. More...

#include <SNMAnchor.h>

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

List of all members.

Public Types

enum  EFlags { NoPosition = 1<<2, NoRotation = 1<<3, NoContainerUpdate = 1<<4 }
 Flags (SceneNodeModifier flags extension) More...

Public Member Functions

PLS_API SNMAnchor (SceneNode &cSceneNode)
 Constructor.
virtual PLS_API ~SNMAnchor ()
 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

Scene node anchor modifier class.

Remarks:
By using this modifier, you can link together scene nodes in multiple ways.

Member Enumeration Documentation

Flags (SceneNodeModifier flags extension)

Enumerator:
NoPosition 

Do NOT manipulate the position

NoRotation 

Do NOT manipulate the rotation

NoContainerUpdate 

Do NOT change the container the attached node is in

Reimplemented from PLScene::SceneNodeModifier.


Constructor & Destructor Documentation

PLS_API PLScene::SNMAnchor::SNMAnchor ( SceneNode cSceneNode)

Constructor.

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

Destructor.


Member Function Documentation

virtual PLS_API void PLScene::SNMAnchor::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.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:24
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported