Foundry::Katana::ViewerUtils::FnBaseLocatorVDC Class Reference

#include <FnBaseLocator.h>

Inheritance diagram for Foundry::Katana::ViewerUtils::FnBaseLocatorVDC:

List of all members.

Classes
struct	LocatorContainer
	A container for various type of registered locator plug-ins.
class	SceneNode
	Scene Nodes are used to build and track the scene graph.
Public Member Functions
virtual void	setup ()
	Initializes this ViewerDelegateComponent.
virtual void	cleanup ()
	Cleans up this ViewerDelegateComponent.
virtual bool	locationEvent (const Foundry::Katana::ViewerAPI::ViewerLocationEvent &event, bool locationHandled)
	Handles viewer location events and maintains the SceneNode tree.
virtual void	locationsSelected (const std::vector< std::string > &locationPaths)
	Tracks the selection state of the scene graph.
virtual void *	getPrivateData (void *inputData)
	Returns private data.
virtual FnAttribute::DoubleAttribute	getBounds (const std::string &locationPath)
	Gets the bounds of the given location.
virtual FnAttribute::DoubleAttribute	computeExtent (const std::string &locationPath)
	Computes the extent of the given location.
void	removeLocation (const std::string &locationPath)
	Handles the removal of scene nodes from the selected path.
virtual SceneNode::Ptr	createSceneNode (const FnKat::ViewerAPI::ViewerLocationEvent &event)
void	dirtyAllViewports ()
	Marks all viewports attached to the ViewerDelegate as dirty.
SceneNode::Ptr	getRootSceneNode () const
	Returns the top-level SceneNode.
std::weak_ptr < LocatorLocationsMap >	getLocatorLocations ()
bool	isLocationSelected (const std::string &locationPath)
bool	isLocationHidden (const std::string &locationPath)
	Returns true if the passed location is hidden.
Static Public Member Functions
static void	flush ()
	Flush plugin Caches.
static void	registerLocator (const std::string &name, LocatorCreateCallback create, LocatorMatchesCallback matches, OverridesBaseGeometryCallback overridesBaseGeometry, LocatorGetBoundsCallback getBounds, LocatorComputeExtentCallback computeExtent)
	Registers a locator class and its callbacks with this VDC.
static LocatorContainerVector	getRegisteredLocators ()
	Returns the list of registered locator plug-in classes.

---

Detailed Description

A base implementation of a ViewerDelegateComponent which tracks/maintains a tree of SceneNode objects and locator plug-ins associated with each location represented by a SceneNode.

---

Member Function Documentation

virtual SceneNode::Ptr Foundry::Katana::ViewerUtils::FnBaseLocatorVDC::createSceneNode

(

const FnKat::ViewerAPI::ViewerLocationEvent &

event

)

[virtual]

Creates a new SceneNode instance based on the given viewer location event. Can be overridden if a custom SceneNode type is desired.

static void Foundry::Katana::ViewerUtils::FnBaseLocatorVDC::flush

(

)

[static]

Flush plugin Caches.

Allows to discard any cache for this plugin when a Flush Caches event occurs.

Reimplemented from Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

Reimplemented in ExampleSpotlightLocatorVDC.

std::weak_ptr<LocatorLocationsMap> Foundry::Katana::ViewerUtils::FnBaseLocatorVDC::getLocatorLocations

(

)

Returns a map of locator plug-ins and the scene graph locations associated with them.

bool Foundry::Katana::ViewerUtils::FnBaseLocatorVDC::isLocationSelected

(

const std::string &

locationPath

)

Returns true if the scene graph location with the given path is currently selected.

---

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

• FnBaseLocator.h