org.eclipse.eavp.viz.modeling.base

Class BasicController

java.lang.Object

org.eclipse.eavp.viz.modeling.base.BasicController

All Implemented Interfaces:

IManagedUpdateable, IManagedUpdateableListener, IController

Direct Known Subclasses:

EdgeController, FaceController, PointController, ShapeController, TestController

public class BasicController
extends java.lang.Object
implements IManagedUpdateable, IManagedUpdateableListener, IController

A base implementation of IController.

Author:

Robert Smith

Constructor Summary

Constructors

Constructor and Description
BasicController() The default constructor.
BasicController(BasicMesh model, BasicView view) Constructor for an IController with its associated model and view.

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.
java.lang.Object	clone()
void	copy(IController otherObject) Deep copy the given object's data into this one.
void	dispose() Dispose the controller and its resources.
boolean	equals(java.lang.Object otherObject)
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
java.util.ArrayList<SubscriptionType>	getSubscriptions(IManagedUpdateable source) Polls the listener for a list of the types of events it wants to receive from the given source.
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.
BasicView	getView() Getter method for the part's view.
int	hashCode()
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	register(IManagedUpdateableListener listener) Register a listener to receive managed updates.
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.
void	unregister(IManagedUpdateableListener listener) Remove a registered listener.
void	update(IManagedUpdateable component, SubscriptionType[] type) Receive an update, including the source component and type of event that triggered the update.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicController

public BasicController()

The default constructor.

BasicController

public BasicController(BasicMesh model,
                       BasicView view)

Constructor for an IController with its associated model and view.

Parameters:

model - The model to be managed.

view - The model's view.

Method Detail

refresh

public void refresh()

Description copied from interface: IController

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

Specified by:

refresh in interface IController

getDisposed

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

Description copied from interface: IController

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

Specified by:

getDisposed in interface IController

Returns:

setDisposed

public void setDisposed(boolean newDisposed)

Description copied from interface: IController

Set the the controller as being disposed.

Specified by:

setDisposed in interface IController

getModel

public IMesh getModel()

Description copied from interface: IController

Getter method for the part's model

Specified by:

getModel in interface IController

Returns:

The controller's managed model.

getView

public BasicView getView()

Description copied from interface: IController

Getter method for the part's view.

Specified by:

getView in interface IController

Returns:

The controller's managed view.

setView

public void setView(BasicView newView)

Description copied from interface: IController

Setter method for the model's view.

Specified by:

setView in interface IController

addEntity

public void addEntity(IController newEntity)

Description copied from interface: IController

Adds an entity to the model.

Specified by:

addEntity in interface IController

dispose

public void dispose()

Description copied from interface: IController

Dispose the controller and its resources.

Specified by:

dispose in interface IController

getEntities

public java.util.ArrayList<IController> getEntities()

Description copied from interface: IController

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

Specified by:

getEntities in interface IController

getEntitiesFromCategory

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

Description copied from interface: IController

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

Specified by:

getEntitiesFromCategory in interface IController

getEntitiesFromCategory

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

Description copied from interface: IController

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

Specified by:

getEntitiesFromCategory in interface IController

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

public java.lang.String getProperty(IMeshProperty property)

Description copied from interface: IController

Get the specified property's value.

Specified by:

getProperty in interface IController

getRepresentation

public Representation getRepresentation()

Description copied from interface: IController

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

Specified by:

getRepresentation in interface IController

getRotation

public double[] getRotation()

Description copied from interface: IController

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

Specified by:

getRotation in interface IController

getScale

public double[] getScale()

Description copied from interface: IController

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

Specified by:

getScale in interface IController

getSize

public double getSize()

Description copied from interface: IController

Get the part's size.

Specified by:

getSize in interface IController

getSkew

public double[] getSkew()

Description copied from interface: IController

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

Specified by:

getSkew in interface IController

getTransformation

public Transformation getTransformation()

Description copied from interface: IController

Get the part's transformation.

Specified by:

getTransformation in interface IController

getTranslation

public double[] getTranslation()

Description copied from interface: IController

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

Specified by:

getTranslation in interface IController

removeEntity

public void removeEntity(IController entity)

Description copied from interface: IController

Remove an entity from the part's child entities.

Specified by:

removeEntity in interface IController

setProperty

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

Description copied from interface: IController

Set the given property to a new value

Specified by:

setProperty in interface IController

setRotation

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

Description copied from interface: IController

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

Specified by:

setRotation in interface IController

setScale

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

Description copied from interface: IController

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

Specified by:

setScale in interface IController

setSize

public void setSize(double newSize)

Description copied from interface: IController

Set the part's size

Specified by:

setSize in interface IController

setSkew

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

Description copied from interface: IController

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

Specified by:

setSkew in interface IController

setTransformation

public void setTransformation(Transformation newTransformation)

Description copied from interface: IController

Set the part's transformation

Specified by:

setTransformation in interface IController

setTranslation

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

Description copied from interface: IController

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

Specified by:

setTranslation in interface IController

addEntityToCategory

public void addEntityToCategory(IController newEntity,
                                IMeshCategory category)

Description copied from interface: IController

Add an entity to the part under the given category.

Specified by:

addEntityToCategory in interface IController

Parameters:

newEntity - The child entity to be added to this part

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

getUpdateManager

public UpdateableSubscriptionManager getUpdateManager()

Description copied from interface: IController

Getter method for the update manager.

Specified by:

getUpdateManager in interface IController

Returns:

The update subscription manager

equals

public boolean equals(java.lang.Object otherObject)

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

copy

public void copy(IController otherObject)

Description copied from interface: IController

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

Specified by:

copy in interface IController

Parameters:

otherObject - The object to copy into this one.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

unregister

public void unregister(IManagedUpdateableListener listener)

Description copied from interface: IManagedUpdateable

Remove a registered listener.

Specified by:

unregister in interface IManagedUpdateable

Parameters:

listener - The object which will no longer receive notifications from this

update

public void update(IManagedUpdateable component,
                   SubscriptionType[] type)

Description copied from interface: IManagedUpdateableListener

Receive an update, including the source component and type of event that triggered the update.

Specified by:

update in interface IManagedUpdateableListener

Parameters:

component - The updateable component the update is coming from

type - The event type that of the update

register

public void register(IManagedUpdateableListener listener)

Description copied from interface: IManagedUpdateable

Register a listener to receive managed updates.

Specified by:

register in interface IManagedUpdateable

Parameters:

listener - The object which will receive future updates

getSubscriptions

public java.util.ArrayList<SubscriptionType> getSubscriptions(IManagedUpdateable source)

Description copied from interface: IManagedUpdateableListener

Polls the listener for a list of the types of events it wants to receive from the given source.

Specified by:

getSubscriptions in interface IManagedUpdateableListener

Parameters:

source - The object which this listener will listen to

Returns:

An array of the event types the listener will be notified of during updates

isRoot

public boolean isRoot()

Description copied from interface: IController

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.

Specified by:

isRoot in interface IController

Returns:

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

isSelected

public boolean isSelected()

Description copied from interface: IController

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

Specified by:

isSelected in interface IController

Returns:

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

setEntities

public void setEntities(EntityMapEntry[] newEntities)

Description copied from interface: IController

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().

Specified by:

setEntities in interface IController

setProperties

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

Description copied from interface: IController

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

Specified by:

setProperties in interface IController

Parameters:

properties - The new map of properties for the mesh.

setRoot

public void setRoot(boolean root)

Description copied from interface: IController

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.

Specified by:

setRoot in interface IController

Parameters:

root - Whether the part is the root node or not

setSelected

public void setSelected(boolean selected)

Description copied from interface: IController

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

Specified by:

setSelected in interface IController

Parameters:

selected - Whether the part is selected or not.