Katana Plug-in APIs 0.1
Public Member Functions | Static Public Member Functions

ExampleSpotlightLocatorVDC Class Reference

#include <ExampleSpotlightLocator.h>

Inheritance diagram for ExampleSpotlightLocatorVDC:
Foundry::Katana::ViewerUtils::FnBaseLocatorVDC Foundry::Katana::ViewerAPI::ViewerDelegateComponent Foundry::Katana::ViewerAPI::ViewerDelegateComponentPluginBase

List of all members.

Public Member Functions

bool locationEvent (const Foundry::Katana::ViewerAPI::ViewerLocationEvent &event, bool locationHandled) override
 Handles viewer location events and maintains the SceneNode tree.
void setOption (FnKat::ViewerAPI::OptionIdGenerator::value_type optionId, FnAttribute::Attribute attr) override
 Sets generic options.

Static Public Member Functions

static void flush ()
 Flush plugin Caches.

Detailed Description

Class implementing a ViewerDelegateComponent which inherrits most of its behaviour from FnBaseLocatorVDC. The only difference is that this class can accept an IntAttribute via setOption() which determines whether a locationEvent() should mark an event as handled when it successfully matches a locator to the event. This works like a global switch the to allow locators to either be instead of the default implementations or in addition to them.


Member Function Documentation

static void ExampleSpotlightLocatorVDC::flush ( ) [inline, static]

Flush plugin Caches.

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

Reimplemented from Foundry::Katana::ViewerUtils::FnBaseLocatorVDC.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator