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

ExampleViewport Class Reference

#include <ExampleViewport.h>

Inheritance diagram for ExampleViewport:
Foundry::Katana::ViewerAPI::Viewport Foundry::Katana::ViewerAPI::ViewportPluginBase

List of all members.

Public Member Functions

void setup ()
 Initializes glew and sets up the default OpenGL state.
void cleanup ()
 Cleans up the Viewport resources.
bool event (const FnEventWrapper &event)
void draw ()
void resize (unsigned int width, unsigned int height)
 Updates the viewport dimensions.
void setOption (OptionIdGenerator::value_type optionId, FnAttribute::Attribute attr)
 Stores the passed option in a map for later retrieval.
FnAttribute::Attribute getOption (OptionIdGenerator::value_type optionId)
 Returns the specified option from a map or an invalid attribute.
void freeze ()
 Freeze the layer state when not visible.
void thaw ()
 Thaw the layer state when made visible.

Static Public Member Functions

static
Foundry::Katana::ViewerAPI::Viewport
create ()
 Returns a new instance of ExampleViewport.
static void flush ()
 Flushes any cached data.

Protected Member Functions

void createDefaultCameras ()
 Creates the default built-in cameras.

Detailed Description

This class implements the Viewport API and is used in conjuction with the ExampleViewerDelegate to draw the scene. The viewport itself does not do very much other than initialize the OpenGL state, and primarily works as a container for ViewportLayers where all of the specialized processing takes place.


Member Function Documentation

void ExampleViewport::draw ( ) [virtual]

Performs a background fill, draws the ViewportLayers and then clears the dirty flag.

Reimplemented from Foundry::Katana::ViewerAPI::Viewport.

bool ExampleViewport::event ( const FnEventWrapper event) [virtual]

Processes UI events. Should return true if the event was handled, otherwise false.

Reimplemented from Foundry::Katana::ViewerAPI::Viewport.


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