org.eclipse.eavp.viz.service.javafx.viewer

Interface IRenderer

All Known Implementing Classes:

Renderer

public interface IRenderer

Interface defines logic for executing and managing a scene via a viewer.

Author:

Tony McCrary (tmccrary@l33tlabs.com)

Method Summary

Modifier and Type	Method and Description
IAttachment	createAttachment(java.lang.Class<? extends IAttachment> clazz) Creates an attachment of the specified type.
void	register(java.lang.Class<? extends IAttachment> type, IAttachmentManager mgr) Associates the supplied IAttachmentManager with the renderer, so attachments can be allocated with the associated type.
boolean	supportsAttachment(java.lang.Class<? extends IAttachment> clazz) Returns true if the renderer supports the supplied attachment type, false otherwise.
void	unregister(java.lang.Class<? extends IAttachment> type) Removes any manager associated with the supplied type from the renderer.

Method Detail

createAttachment

IAttachment createAttachment(java.lang.Class<? extends IAttachment> clazz)

Creates an attachment of the specified type.

Parameters:

clazz - the type of IAttachment to allocate.

Returns:

an IAttachment instance of the specified type or null if the attachment cannot be allocated.

supportsAttachment

boolean supportsAttachment(java.lang.Class<? extends IAttachment> clazz)

Returns true if the renderer supports the supplied attachment type, false otherwise.

Parameters:

clazz - the type of attachment to check for

Returns:

true if the renderer supports the supplied attachment type, false otherwise.

register

void register(java.lang.Class<? extends IAttachment> type,
              IAttachmentManager mgr)

Associates the supplied IAttachmentManager with the renderer, so attachments can be allocated with the associated type.

Parameters:

type - the type of attachments supplied by the manager

mgr - the manager instance to handle allocating attachments

unregister

void unregister(java.lang.Class<? extends IAttachment> type)

Removes any manager associated with the supplied type from the renderer.

Parameters:

type - the type of attachment manager to unregister