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

ExampleSceneLayer Class Reference

#include <ExampleSceneLayer.h>

Inheritance diagram for ExampleSceneLayer:
Foundry::Katana::ViewerAPI::ViewportLayer Foundry::Katana::ViewerAPI::ViewportLayerPluginBase

List of all members.

Public Member Functions

virtual void setup ()
 Retrieves a pointer to the ExampleViewerDelegate's root SceneNode.
virtual void cleanup ()
 Cleans up the resources.
virtual void draw ()
 Traverses the SceneNode tree drawing each visible location.
void pickerDraw (unsigned int x, unsigned int y, unsigned int w, unsigned int h, const PickedAttrsMap &ignoreAttrs)
 Draws the SceneNode tree for picking.
virtual bool event (const FnEventWrapper &eventData)
 Processes UI events.
virtual void resize (unsigned int width, unsigned int height)
 Updates to the new viewport dimensions.
void freeze ()
 Freezes the layer state when not visible.
void thaw ()
 Thaws the layer state when made visible.

Static Public Member Functions

static ViewportLayercreate ()
 Returns a new instance of ExampleSceneLayer.

Detailed Description

This layer is responsible for traversing the tree of SceneNodes, drawing each node as it goes.

The SceneNode objects are owned by the ExampleViewerDelegate allowing multiple viewports to share the same data on the graphics card.


Member Function Documentation

virtual bool ExampleSceneLayer::event ( const FnEventWrapper eventData) [virtual]

Processes UI events.

Called whenever a user interaction event occurs. This will be also propagated through the ViewerLayers of this ViewportLayer.

Parameters:
eventDataThe event data (see FnEventWrapper).
Returns:
True if the event has been handled, in that case it will not be passed to the following layers. Otherwise false and the event will be passed to the following layers.

Reimplemented from Foundry::Katana::ViewerAPI::ViewportLayer.


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