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

Interface IModelPart

All Known Implementing Classes:

BasicAttachment, FXAttachment, FXGeometryAttachment, FXMeshAttachment

public interface IModelPart

Interface for accepting and working with ICE modeling parts.

Author:

Tony McCrary (tmccrary@l33tlabs.com), Robert Smith

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	clearShapes() Removes all shapes associated with this entity.
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	removeGeometry(Geometry geom) Removes a geometry from those displayed in the model.
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.

Method Detail

addGeometry

void addGeometry(IController geom)

Adds a Geometry instance to this entity.

Parameters:

geom - an ICE Geometry instance

addGeometry

void addGeometry(Geometry geom)

Adds a Geometry instance to this entity.

Parameters:

geom - Geometry instance

addShape

void addShape(INode shape)

Adds a shape to this entity.

Parameters:

shape - An EAVP CSG INode instance.

removeGeometry

void removeGeometry(Geometry geom)

Removes a geometry from those displayed in the model.

Parameters:

geom - The geometry to be removed.

removeShape

void removeShape(INode shape)

Removes the supplied INode from this entity.

Parameters:

shape - The EAVP INode to remove.

hasShape

boolean hasShape(INode shape)

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

Parameters:

shape - EAVP CSG INode to test for

Returns:

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

getShape

INode getShape(int index)

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

Parameters:

index - the index to retrieve the IShape at

Returns:

a CSG INode instance or null if one cannot be found

getShapes

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

Returns a list of the shapes associated with this entity.

Optionally, a copy can be made of the list.

Parameters:

copy - if true, the returned list will be a copy

Returns:

a List of INodes associated with this shape.

clearShapes

void clearShapes()

Removes all shapes associated with this entity.

setImmutable

void setImmutable(boolean immutable)

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

Parameters:

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

isImmutable

boolean isImmutable()

Returns true if the entity is immutable, false otherwise.

setVisible

void setVisible(boolean visible)

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

Parameters:

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

isVisible

boolean isVisible()

Returns true if the entity is visible, false otherwise.