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

ExampleSpotlightLocator Class Reference

#include <ExampleSpotlightLocator.h>

Inheritance diagram for ExampleSpotlightLocator:
Foundry::Katana::ViewerUtils::FnBaseLocator

List of all members.

Public Member Functions

virtual void setup ()
 Initializes the locator plug-in's resources.
virtual void cleanup ()
 Cleans up the locator plug-in's resources.
virtual void draw (const std::string &locationPath)
virtual void pickerDraw (const std::string &locationPath)
void generateCone (float radius, float height, int segments, std::vector< float > &vertices, std::vector< unsigned int > &indices)
 Returns the vertex and index data for a cone.

Static Public Member Functions

static bool matches (const FnKat::ViewerAPI::ViewerLocationEvent &event)
static bool overridesBaseGeometry (const FnKat::ViewerAPI::ViewerLocationEvent &event)
static FnAttribute::DoubleAttribute getBounds (const FnKat::ViewerAPI::ViewerLocationEvent &event)
 Gets the bounds of the given location.
static FnAttribute::DoubleAttribute computeExtent (const FnKat::ViewerAPI::ViewerLocationEvent &event)
 Computes the extent of the given location.

Detailed Description

Example of a class implementing a locator plug-in that draws a cone at matching light locations.


Member Function Documentation

virtual void ExampleSpotlightLocator::draw ( const std::string &  locationPath) [virtual]

Draws the object that's represented by the scene graph location with the given path using the given shader program.

Implements Foundry::Katana::ViewerUtils::FnBaseLocator.

static bool ExampleSpotlightLocator::matches ( const FnKat::ViewerAPI::ViewerLocationEvent event) [static]

Determines whether this locator plug-in should be used to draw the location described in the given viewer location event.

static bool ExampleSpotlightLocator::overridesBaseGeometry ( const FnKat::ViewerAPI::ViewerLocationEvent event) [static]

Determines whether this locator plug-in overrides the standard geometry representation for matched locations.

virtual void ExampleSpotlightLocator::pickerDraw ( const std::string &  locationPath) [virtual]

Draws the object that's represented by the scene graph location with the given path using the given shader program as part of a picking pass.

Implements Foundry::Katana::ViewerUtils::FnBaseLocator.


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