org.eclipse.eavp.viz.modeling.base

Interface IController

All Superinterfaces:

IManagedUpdateable, IManagedUpdateableListener

All Known Subinterfaces:

ITransparentController, IWireframeController

All Known Implementing Classes:

BasicController, DetailedEdgeController, EdgeController, FaceController, FXEdgeController, FXVertexController, NekPolygonController, PointController, ShapeController, ShapeTester.TestShape, TestController, TestEdge, TubeController, VertexController

public interface IController
extends IManagedUpdateable, IManagedUpdateableListener

A interface which is responsible for user interactions with the underlying data structures which represent a part in a model. An IController is associated with an IMesh, which is the internal representation of the part and any associated data, and an IView, which holds the graphical representation of the object in the native data types of the rendering engine. The IController is meant to completely encapsulate the functionality of the part. All client interactions with a part should take place through function calls to the part's IController, without regard as to whether they are internally delegated to the model, the view, or both. The controller should not expose the model or view, or their implementation details, to the client.

Author:

Robert Smith

Method Summary

Modifier and Type	Method and Description
void	addEntity(IController newEntity) Adds an entity to the model.
void	addEntityToCategory(IController newEntity, IMeshCategory category) Add an entity to the part under the given category.
void	copy(IController otherObject) Deep copy the given object's data into this one.
void	dispose() Dispose the controller and its resources.
java.util.concurrent.atomic.AtomicBoolean	getDisposed() Checks whether or not this part and its resources have been disposed.
java.util.ArrayList<IController>	getEntities() Gets a list of all the part's children entities.
java.util.ArrayList<IController>	getEntitiesFromCategory(IMeshCategory category) Returns all the part's child entities of the given category
<T extends IController> java.util.ArrayList<T>	getEntitiesFromCategory(IMeshCategory category, java.lang.Class<T> returnType) Return all of the part's children entities of a given category cast to a list of the specified return type.
IMesh	getModel() Getter method for the part's model
java.lang.String	getProperty(IMeshProperty property) Get the specified property's value.
Representation	getRepresentation() Get a wrapper containing the part's representation as an object specific to the application rendering it.
double[]	getRotation() Get the part's rotation in the x, y, and z directions
double[]	getScale() Get the part's scale in the x, y, and z directions.
double	getSize() Get the part's size.
double[]	getSkew() Get the part's skew in the x, y, and z directions
Transformation	getTransformation() Get the part's transformation.
double[]	getTranslation() Get the part's translation in the x, y, and z directions
UpdateableSubscriptionManager	getUpdateManager() Getter method for the update manager.
IView	getView() Getter method for the part's view.
boolean	isRoot() Checks whether the part is the root node of the tree.
boolean	isSelected() Checks whether the part is selected.
void	refresh() Alerts the view to refresh itself based on changes in the model
void	removeEntity(IController entity) Remove an entity from the part's child entities.
void	setDisposed(boolean newDisposed) Set the the controller as being disposed.
void	setEntities(EntityMapEntry[] newEntities) Set the mesh's map of entities to be equal to the provided map.
void	setProperties(java.util.Map<IMeshProperty,java.lang.String> properties) Set the mesh's properties according to the given map.
void	setProperty(IMeshProperty property, java.lang.String value) Set the given property to a new value
void	setRoot(boolean root) Set the part as being the root node of the tree.
void	setRotation(double x, double y, double z) Set the part's rotation in the x, y, and x directions.
void	setScale(double x, double y, double z) Set the part's scale in the x, y, and x directions.
void	setSelected(boolean selected) Set the part as being selected.
void	setSize(double newSize) Set the part's size
void	setSkew(double x, double y, double z) Set the part's skew in the x, y, and x directions.
void	setTransformation(Transformation newTransformation) Set the part's transformation
void	setTranslation(double x, double y, double z) Set the part's translation in the x, y, and x directions.
void	setView(BasicView newView) Setter method for the model's view.

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IManagedUpdateable

register, unregister

Methods inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IManagedUpdateableListener

getSubscriptions, update

Method Detail

refresh

void refresh()

Alerts the view to refresh itself based on changes in the model

getDisposed

java.util.concurrent.atomic.AtomicBoolean getDisposed()

Checks whether or not this part and its resources have been disposed.

Returns:

setDisposed

void setDisposed(boolean newDisposed)

Set the the controller as being disposed.

getModel

IMesh getModel()

Getter method for the part's model

Returns:

The controller's managed model.

getView

IView getView()

Getter method for the part's view.

Returns:

The controller's managed view.

setView

void setView(BasicView newView)

Setter method for the model's view.

addEntity

void addEntity(IController newEntity)

Adds an entity to the model.

dispose

void dispose()

Dispose the controller and its resources.

getEntities

java.util.ArrayList<IController> getEntities()

Gets a list of all the part's children entities.

getEntitiesFromCategory

java.util.ArrayList<IController> getEntitiesFromCategory(IMeshCategory category)

Returns all the part's child entities of the given category

getEntitiesFromCategory

<T extends IController> java.util.ArrayList<T> getEntitiesFromCategory(IMeshCategory category,
                                                                       java.lang.Class<T> returnType)

Return all of the part's children entities of a given category cast to a list of the specified return type.

Parameters:

category - The category of entities to return

returnType - The class to which members of the category belong.

Returns:

All the entities in the map for the specified category, cast to the given type.

getProperty

java.lang.String getProperty(IMeshProperty property)

Get the specified property's value.

getRepresentation

Representation getRepresentation()

Get a wrapper containing the part's representation as an object specific to the application rendering it.

getRotation

double[] getRotation()

Get the part's rotation in the x, y, and z directions

getScale

double[] getScale()

Get the part's scale in the x, y, and z directions.

getSize

double getSize()

Get the part's size.

getSkew

double[] getSkew()

Get the part's skew in the x, y, and z directions

getTransformation

Transformation getTransformation()

Get the part's transformation.

getTranslation

double[] getTranslation()

Get the part's translation in the x, y, and z directions

removeEntity

void removeEntity(IController entity)

Remove an entity from the part's child entities.

setProperty

void setProperty(IMeshProperty property,
                 java.lang.String value)

Set the given property to a new value

setRotation

void setRotation(double x,
                 double y,
                 double z)

Set the part's rotation in the x, y, and x directions.

setScale

void setScale(double x,
              double y,
              double z)

Set the part's scale in the x, y, and x directions.

setSize

void setSize(double newSize)

Set the part's size

setSkew

void setSkew(double x,
             double y,
             double z)

Set the part's skew in the x, y, and x directions.

setTransformation

void setTransformation(Transformation newTransformation)

Set the part's transformation

setTranslation

void setTranslation(double x,
                    double y,
                    double z)

Set the part's translation in the x, y, and x directions.

addEntityToCategory

void addEntityToCategory(IController newEntity,
                         IMeshCategory category)

Add an entity to the part under the given category.

Parameters:

newEntity - The child entity to be added to this part

category - The category under which to add the new child entity

isRoot

boolean isRoot()

Checks whether the part is the root node of the tree. A convenience method equivalent to getProperty(MeshProperty.ROOT) except it returns a boolean instead of a String.

Returns:

True if the part is selected and false if it is not.

isSelected

boolean isSelected()

Checks whether the part is selected. A convenience method equivalent to getProperty(MeshProperty.SELECTED) except it returns a boolean instead of a String.

Returns:

True if the part is selected and false if it is not.

setEntities

void setEntities(EntityMapEntry[] newEntities)

Set the mesh's map of entities to be equal to the provided map. This will be equivalent to clearing the map with removeEntity() calls and adding each individual member of newEntities as if by invoking addEntityToCategory().

Parameters:

newEntities -

setProperties

void setProperties(java.util.Map<IMeshProperty,java.lang.String> properties)

Set the mesh's properties according to the given map.

Parameters:

properties - The new map of properties for the mesh.

setRoot

void setRoot(boolean root)

Set the part as being the root node of the tree. A convenience method equivalent to setProperty(MeshProperty.ROOT, ___) except it takes a boolean instead of a String.

Parameters:

root - Whether the part is the root node or not

setSelected

void setSelected(boolean selected)

Set the part as being selected. A convenience method equivalent to setProperty(MeshProperty.SELECTED, ___) except it takes a boolean instead of a String.

Parameters:

selected - Whether the part is selected or not.

getUpdateManager

UpdateableSubscriptionManager getUpdateManager()

Getter method for the update manager.

Returns:

The update subscription manager

copy

void copy(IController otherObject)

Deep copy the given object's data into this one.

Parameters:

otherObject - The object to copy into this one.