IgnoreComponent Class Reference

A ViewerDelegateComponent that ignores locations and location types. More...

#include <IgnoreComponent.h>

Inheritance diagram for IgnoreComponent:

List of all members.

Public Member Functions
void	setup ()
	Initializes the ViewportDelegateComponent's resources.
void	cleanup ()
	Cleans up the ViewportDelegateComponent's resources.
bool	locationEvent (const Foundry::Katana::ViewerAPI::ViewerLocationEvent &event, bool locationHandled) override
	Notification of scene graph location state changes.
void	locationsSelected (const std::vector< std::string > &locations) override
	Called when the location selection changes in Katana.
Static Public Member Functions
static void	flush ()
	Flush plugin Caches.

---

Detailed Description

A ViewerDelegateComponent that ignores locations and location types.

This is a generic utility ViewerDelegateComponent that will ignore locations and location types defined in two options in the ViewerDelegate. The options are defined by the strings kIgnoreLocationsOption and kIgnoreLocationTypesOption. Whenever the Viewer delegate has any of these options set, then whenever a "locationEvent" callback function is called this will check if the location and type match those options. If so, then these functions will return "true", causing any subsequent ViewerDelegateComponents and the ViewerDelegate to receive the event with locationHandled=true.

---

Member Function Documentation

static void IgnoreComponent::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.

bool IgnoreComponent::locationEvent	(	const Foundry::Katana::ViewerAPI::ViewerLocationEvent &	event,
		bool	locationHandled
	)		[override, virtual]

Notification of scene graph location state changes.

Parameters:

event	Struct containing location event information (see "FnViewerLocationEvent.h" for details).
locationHandled	True if an already processed (later added) ViewerDelegateComponent has stated that it is handling this location by returning true. In this case, the ViewerDelegateComponent should not draw its own representation.

Returns:

true if the other ViewerDelegateComponents added to the ViewerDelegate before this one should receive locationHandled=true, false otherwise.

Implements Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

void IgnoreComponent::locationsSelected

(

const std::vector< std::string > &

locationPaths

)

[inline, override, virtual]

Called when the location selection changes in Katana.

Parameters:

locationPaths

The selected location paths.

Implements Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

---

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

• IgnoreComponent.h