org.eclipse.eavp.viz.service.javafx.scene.model

Interface IAttachment

All Known Implementing Classes:

Attachment, BasicAttachment, CameraAttachment, FXAttachment, FXCameraAttachment, FXGeometryAttachment, FXMeshAttachment, GeometryAttachment

public interface IAttachment

Interface for attachments, which provide new capabilities for INode instances. These capabilities can be things like rendering geometry, providing advanced control over the node and more.

Because inheritance is a very poor, brittle way to extend node capabilities in a scene hierarchy, this approach allows for design via composition.

Author:

Tony McCrary (tmccrary@l33tlabs.com)

Method Summary

Modifier and Type	Method and Description
void	attach(INode owner) Adds this instance to the supplied node.
void	detach(INode owner) Removes this instance from the supplied node.
INode	getOwner() Returns the node this attachment is attached to or null if there is no attached node.
java.lang.Class<?>	getType() Returns the class type of the attachment.
boolean	isSingleton() If the attachment is a singleton, only a single instance of the attachment can be attached to any given node.

Method Detail

getOwner

INode getOwner()

Returns the node this attachment is attached to or null if there is no attached node.

Returns:

the INode currently attached or null if a node has not been attached.

attach

void attach(INode owner)

Adds this instance to the supplied node. The attachment's functionality will be applied to the new owner node.

If the attachment is a singleton, this will replace any existing attachment of the same type.

Parameters:

owner - the node to attach to

detach

void detach(INode owner)

Removes this instance from the supplied node. Any functionality provided by this attachment will be removed from the owner node.

If the supplied node is not attached, this is a no-op.

Parameters:

owner - the node to detach from

isSingleton

boolean isSingleton()

If the attachment is a singleton, only a single instance of the attachment can be attached to any given node.

Returns:

true if the attachment type is a singleton, false otherwise.

getType

java.lang.Class<?> getType()

Returns the class type of the attachment. Note that this may not be the same as the concrete type.

Returns:

the class type of the attachment