BallComponent Class Reference

Inheritance diagram for BallComponent:

List of all members.

Public Member Functions
void	setup ()
	Initializes the ViewportDelegateComponent's resources.
void	cleanup ()
	Cleans up the ViewportDelegateComponent's resources.
bool	locationEvent (const Foundry::Katana::ViewerAPI::ViewerLocationEvent &event, bool locationHandled)
	Notification of scene graph location state changes.
void	locationsSelected (const std::vector< std::string > &locations)
	Called when the location selection changes in Katana.
void *	getPrivateData (void *inputData)
	Returns some arbitrary data.
Static Public Member Functions
static void	flush ()
	Flush plugin Caches.

---

Member Function Documentation

static void BallComponent::flush

(

)

[static]

Flush plugin Caches.

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

Reimplemented from Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

void* BallComponent::getPrivateData

(

void *

inputData

)

[virtual]

Returns some arbitrary data.

This can be used by other plugins to access some data that is specific to this object after it is compiled, allowing built-in parts of existing Viewers to be extendable by other plugins like ViewerDelegateComponents, Viewports and ViewportLayers.

This function should be called by other plugins after getting a ManipulatorWrapperPtr and converting it into a concrete instance via ManipulatorWrapper::getPluginInstance(). These other plugins will have to be built with the same compiler and using the same compiler flags as the ViewerDelegate so that this data can be cast and used without running into C++ name mangling issues.

Parameters:

inputData

A pointer to some input data that can be used to produce the returned data.

Returns:

The arbitrary private data. A void pointer that can be cast into specific object types by other plugins.

Reimplemented from Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

bool BallComponent::locationEvent	(	const Foundry::Katana::ViewerAPI::ViewerLocationEvent &	event,
		bool	locationHandled
	)		[virtual]

Notification of scene graph location state changes.

Parameters:

event	Struct containing location event information (see "FnViewerLocationEvent.h" for details).
locationHandled	True if an already processed (later added) ViewerDelegateComponent has stated that it is handling this location by returning true. In this case, the ViewerDelegateComponent should not draw its own representation.

Returns:

true if the other ViewerDelegateComponents added to the ViewerDelegate before this one should receive locationHandled=true, false otherwise.

Implements Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

void BallComponent::locationsSelected

(

const std::vector< std::string > &

locationPaths

)

[virtual]

Called when the location selection changes in Katana.

Parameters:

locationPaths

The selected location paths.

Implements Foundry::Katana::ViewerAPI::ViewerDelegateComponent.

---

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

• BallLocationType.h