Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer Class Reference

#include <FnBaseLocator.h>

Inheritance diagram for Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer:

List of all members.

Public Member Functions
virtual void	freeze ()
	Freezes the ViewportLayer when the viewport widget is hidden.
virtual void	thaw ()
	Thaws the ViewportLayer when the viewport widget is shown.
virtual void	setup ()
	Initializes the GL components of the ViewportLayer.
virtual void	cleanup ()
	Cleans up the ViewportLayer resources.
virtual void	draw ()
	Draws the viewport layer's contents.
virtual void	pickerDraw (unsigned int x, unsigned int y, unsigned int w, unsigned int h, const Foundry::Katana::ViewerAPI::PickedAttrsMap &ignoreAttrs)
	Draws the viewport layer's contents for a selection picker pass.
virtual bool	usesPickingOnHover ()
virtual void	resize (unsigned int width, unsigned int height)
	Processes viewport resizing.
virtual void	setOption (Foundry::Katana::ViewerAPI::OptionIdGenerator::value_type optionId, FnAttribute::Attribute attr)
	Sets a generic option.
virtual void	initializeLocators ()
	Creates all needed local instances of locator plug-ins.
virtual void	drawLocators (bool isPicking, std::set< std::string > &ignoreLocations)

---

Detailed Description

Class implementing a ViewportLayer that owns instances of locator plug-ins and is responsible for drawing them.

---

Member Function Documentation

virtual void Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer::drawLocators	(	bool	isPicking,
		std::set< std::string > &	ignoreLocations
	)		[virtual]

Draws locator plug-ins for their associated locations, optionally ignoring locations with the given scene graph location paths.

virtual void Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer::freeze

(

)

[inline, virtual]

Freezes the ViewportLayer when the viewport widget is hidden.

Allows the ViewportLayer to freeze its activities when the viewport is not visible. This allows the ViewerDelegate to stop any kind of unecessary processing that might happen during that time.

Implements Foundry::Katana::ViewerAPI::ViewportLayer.

virtual void Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer::thaw

(

)

[inline, virtual]

Thaws the ViewportLayer when the viewport widget is shown.

Allows the ViewportLayer to restart its activities when the viewport becomes visible. This restarts the activities paused by freeze().

This function is exposed in the Viewport Python class.

Implements Foundry::Katana::ViewerAPI::ViewportLayer.

virtual bool Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer::usesPickingOnHover

(

)

[inline, virtual]

Returns true if the viewport layer picks objects when the pointer is hovering over them.

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

---

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

• FnBaseLocator.h