Foundry::Katana::ViewerAPI::ViewerLocationEvent Struct Reference

Struct describing a Viewer Location Event. More...

#include <FnViewerLocationEvent.h>

List of all members.

Public Member Functions
	ViewerLocationEvent ()
	ViewerLocationEvent (const FnViewerLocationEventStruct &cStruct)
FnViewerLocationEventStruct	getCStruct () const
Public Attributes
std::string	locationPath
	Scene graph location path (always provided).
FnAttribute::GroupAttribute	attributes
	Location attributes (always provided).
FnAttribute::DoubleAttribute	localXformMatrix
bool	localXformIsAbsolute
bool	excluded
bool	descendantsHidden
bool	isVirtualLocation
ViewerLocationStateChanges	stateChanges
	Location state changes signalled by this event.

---

Detailed Description

Struct describing a Viewer Location Event.

---

Constructor & Destructor Documentation

Foundry::Katana::ViewerAPI::ViewerLocationEvent::ViewerLocationEvent

(

)

[inline]

Default constructor.

Foundry::Katana::ViewerAPI::ViewerLocationEvent::ViewerLocationEvent

(

const FnViewerLocationEventStruct &

cStruct

)

[inline, explicit]

Constructor for creating a ViewerLocationEvent based on a given viewer location event data structure.

Parameters:

cStruct

The viewer location event data structure to copy.

---

Member Function Documentation

FnViewerLocationEventStruct Foundry::Katana::ViewerAPI::ViewerLocationEvent::getCStruct

(

)

const [inline]

Returns:

A viewer location event data structure containing the details of this viewer location event.

References attributes, localXformMatrix, and locationPath.

---

Member Data Documentation

bool Foundry::Katana::ViewerAPI::ViewerLocationEvent::descendantsHidden

This property determines whether or not Viewer proxies are displayed, and is provided for use by custom proxy implementations. It is true if all of the location's potential [non-virtual] descendants are explicitly hidden, or it has none to hide. This property is determined when the location is produced, and cannot rely on the final number of existing children once they are also cooked: i.e. this property be false for leaf locations that have *potential* children are deleted when cooked.

bool Foundry::Katana::ViewerAPI::ViewerLocationEvent::excluded

A location can be 'excluded' if it is not explicitly made visible, but a descendant location is. A location is also excluded if it is explicitly hidden or has a hidden ancestor. In these cases, any representation of the non-leaf location should not be drawn.

bool Foundry::Katana::ViewerAPI::ViewerLocationEvent::isVirtualLocation

Virtual locations are not part of the scene graph, but are generated as additional children based on location attributes, such as Viewer proxy locations. Note that location paths of virtual locations should always be distinguishable from real scene graph location paths.

bool Foundry::Katana::ViewerAPI::ViewerLocationEvent::localXformIsAbsolute

True if the local transform is reset to identity using the 'origin' attribute convention. If true, the location's ancestors' transforms do not contribute to the global transform of this location and its descendants.

FnAttribute::DoubleAttribute Foundry::Katana::ViewerAPI::ViewerLocationEvent::localXformMatrix

Location local transform as a 4x4 matrix (16 value DoubleAttribute) if one exists (always provided), otherwise an invalid attribute (which should be interpreted as an identity matrix, or otherwise ignored).

Referenced by getCStruct().

---

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

• FnViewerLocationEvent.h