org.eclipse.eavp.viz.service.javafx.canvas

Class BasicAttachment

java.lang.Object

org.eclipse.eavp.viz.service.javafx.canvas.Attachment

org.eclipse.eavp.viz.service.javafx.canvas.BasicAttachment

All Implemented Interfaces:

IRenderElementHolder, IModelPart, IAttachment

Direct Known Subclasses:

FXAttachment

public abstract class BasicAttachment
extends Attachment
implements IModelPart, IRenderElementHolder

Base for GeometryAttachment implementations, which provide nodes with the ability to display ICE Geometry elements and their constituent IShapes.

Author:

Tony McCrary (tmccrary@l33tlabs.com)

Constructor Summary

Constructors

Constructor and Description
BasicAttachment()

Method Summary

Modifier and Type	Method and Description
void	addGeometry(Geometry geom) Adds a Geometry instance to this entity.
void	addGeometry(IController geom) Adds a Geometry instance to this entity.
void	addShape(INode shape) Adds a shape to this entity.
void	attach(INode owner) Adds this instance to the supplied node.
void	clearShapes() Removes all shapes associated with this entity.
void	detach(INode owner) Removes this instance from the supplied node.
IRenderElement	getRender(INode node) Get the IRenderElement for the given node.
java.util.ArrayList<IRenderElement>	getRenderedNodes() Get the IRenderElements contained by this attachment.
INode	getShape(int index) Returns the IShape at the specified index or null if it cannot be found.
java.util.List<INode>	getShapes(boolean copy) Returns a list of the shapes associated with this entity.
boolean	hasShape(INode shape) Returns true if the entity contains the supplied INode, false otherwise.
boolean	isImmutable() Returns true if the entity is immutable, false otherwise.
boolean	isVisible() Returns true if the entity is visible, false otherwise.
void	removeShape(INode shape) Removes the supplied INode from this entity.
void	setImmutable(boolean immutable) Sets the entity to be immutable, which means it's values cannot be changed (no new geometry or shapes).
void	setVisible(boolean visible) Sets the entity to be visible or not visible in the scene.

Methods inherited from class org.eclipse.eavp.viz.service.javafx.canvas.Attachment

getOwner, isSingleton

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.eavp.viz.service.javafx.canvas.IModelPart

removeGeometry

Methods inherited from interface org.eclipse.eavp.viz.service.javafx.scene.model.IAttachment

getType

Constructor Detail

BasicAttachment

public BasicAttachment()

Method Detail

addGeometry

public void addGeometry(IController geom)

Description copied from interface: IModelPart

Adds a Geometry instance to this entity.

Specified by:

addGeometry in interface IModelPart

Parameters:

geom - an ICE Geometry instance

See Also:

IModelPart.addGeometry(Geometry)

addGeometry

public void addGeometry(Geometry geom)

Description copied from interface: IModelPart

Adds a Geometry instance to this entity.

Specified by:

addGeometry in interface IModelPart

Parameters:

geom - Geometry instance

See Also:

IModelPart.addGeometry(Geometry)

addShape

public void addShape(INode shape)

Description copied from interface: IModelPart

Adds a shape to this entity.

Specified by:

addShape in interface IModelPart

Parameters:

shape - An EAVP CSG INode instance.

See Also:

IModelPart#addShape(Geometry)

attach

public void attach(INode owner)

Description copied from interface: IAttachment

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.

Specified by:

attach in interface IAttachment

Overrides:

attach in class Attachment

Parameters:

owner - the node to attach to

See Also:

IAttachment.attach(INode)

detach

public void detach(INode owner)

Description copied from interface: IAttachment

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.

Specified by:

detach in interface IAttachment

Overrides:

detach in class Attachment

Parameters:

owner - the node to detach from

See Also:

IAttachment.detach(INode)

removeShape

public void removeShape(INode shape)

Description copied from interface: IModelPart

Removes the supplied INode from this entity.

Specified by:

removeShape in interface IModelPart

Parameters:

shape - The EAVP INode to remove.

See Also:

IModelPart#addShape(Geometry)

hasShape

public boolean hasShape(INode shape)

Description copied from interface: IModelPart

Returns true if the entity contains the supplied INode, false otherwise.

Specified by:

hasShape in interface IModelPart

Parameters:

shape - EAVP CSG INode to test for

Returns:

true if the entity contains the supplied INode, false otherwise.

getShape

public INode getShape(int index)

Description copied from interface: IModelPart

Returns the IShape at the specified index or null if it cannot be found.

Specified by:

getShape in interface IModelPart

Parameters:

index - the index to retrieve the IShape at

Returns:

a CSG INode instance or null if one cannot be found

getShapes

public java.util.List<INode> getShapes(boolean copy)

Description copied from interface: IModelPart

Returns a list of the shapes associated with this entity.

Optionally, a copy can be made of the list.

Specified by:

getShapes in interface IModelPart

Parameters:

copy -

Returns:

clearShapes

public void clearShapes()

Description copied from interface: IModelPart

Removes all shapes associated with this entity.

Specified by:

clearShapes in interface IModelPart

setVisible

public void setVisible(boolean visible)

Description copied from interface: IModelPart

Sets the entity to be visible or not visible in the scene.

Specified by:

setVisible in interface IModelPart

Parameters:

visible - if true, the entity will be made visible otherwise the entity will not be visible

isVisible

public boolean isVisible()

Description copied from interface: IModelPart

Returns true if the entity is visible, false otherwise.

Specified by:

isVisible in interface IModelPart

isImmutable

public boolean isImmutable()

Description copied from interface: IModelPart

Returns true if the entity is immutable, false otherwise.

Specified by:

isImmutable in interface IModelPart

Returns:

setImmutable

public void setImmutable(boolean immutable)

Description copied from interface: IModelPart

Sets the entity to be immutable, which means it's values cannot be changed (no new geometry or shapes).

Specified by:

setImmutable in interface IModelPart

Parameters:

immutable - if true, the entity will be made immutable otherwise the entity will be mutable

getRenderedNodes

public java.util.ArrayList<IRenderElement> getRenderedNodes()

Get the IRenderElements contained by this attachment.

Returns:

The list of IRenderElements corresponding to the Geometry added to this attachment.

getRender

public IRenderElement getRender(INode node)

Description copied from interface: IRenderElementHolder

Get the IRenderElement for the given node.

Specified by:

getRender in interface IRenderElementHolder

Parameters:

node - The node whose IRenderElement is sought.

Returns:

The IRenderElement containing the given node as its source.