Foundry::Katana::ViewerAPI::ViewerLocationStateChanges Struct Reference

Struct containing Viewer Location Event state changes. More...

#include <FnViewerLocationEvent.h>

List of all members.

Public Member Functions
	ViewerLocationStateChanges ()
	ViewerLocationStateChanges (FnViewerLocationEventBitField flags)
Public Attributes
bool	locationRemoved
bool	attributesUpdated
bool	localXformUpdated
bool	excludedChanged
	The 'excluded' property has changed (see ViewerLocationEvent).
bool	descendantsHiddenChanged
	The 'descendantsHidden' property has changed (see ViewerLocationEvent).

---

Detailed Description

Struct containing Viewer Location Event state changes.

---

Constructor & Destructor Documentation

Foundry::Katana::ViewerAPI::ViewerLocationStateChanges::ViewerLocationStateChanges

(

)

[inline]

Default constructor.

Foundry::Katana::ViewerAPI::ViewerLocationStateChanges::ViewerLocationStateChanges

(

FnViewerLocationEventBitField

flags

)

[inline, explicit]

Constructor for creating a ViewerLocationStateChanges object based on a given viewer location event bit field of flags.

Parameters:

flags

The viewer location event bit field to parse in order to initialize the new object's boolean member variables.

---

Member Data Documentation

bool Foundry::Katana::ViewerAPI::ViewerLocationStateChanges::attributesUpdated

The location has either been newly added, or its attributes have been updated. As 'xform' attributes are included, this is always true if localXformUpdated is true.

bool Foundry::Katana::ViewerAPI::ViewerLocationStateChanges::localXformUpdated

The local xform as been updated (the local matrix and/or its 'isAbsolute' state).

bool Foundry::Katana::ViewerAPI::ViewerLocationStateChanges::locationRemoved

The scene graph location and all descendants have been removed from the scene graph.

---

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

• FnViewerLocationEvent.h