org.eclipse.eavp.viz.modeling.base

Class BasicMesh

java.lang.Object

org.eclipse.eavp.viz.modeling.base.BasicMesh

All Implemented Interfaces:

IManagedUpdateable, IManagedUpdateableListener, IMesh

Direct Known Subclasses:

Edge, Face, Point, Shape, TestMesh

public class BasicMesh
extends java.lang.Object
implements IManagedUpdateableListener, IManagedUpdateable, IMesh

Base implementation of IMesh.

Author:

Robert Smith

Constructor Summary

Constructors

Constructor and Description
BasicMesh() The default constructor
BasicMesh(java.util.ArrayList<IController> entities, MeshType type) A constructor which provides a set of child entities and a mesh type
BasicMesh(java.util.List<IController> entities) A constructor which provides a set of child entities for the MeshComponent.
BasicMesh(java.util.Map<java.lang.Object,java.lang.Object> input, MeshType type) A constructor taking a map of input to initialize the MeshComponent.
BasicMesh(MeshType type) A constructor allowing the user to specify the mesh's type.

Method Summary

Modifier and Type	Method and Description
void	addEntity(IController newEntity) Add a new entity to the part.
void	addEntityToCategory(IController newEntity, IMeshCategory category) Adds a new child entity under the given category.
java.lang.Object	clone()
void	copy(IMesh otherObject) Deep copies the contents of another AbstractMeshComponent into this one.
boolean	equals(java.lang.Object otherObject)
java.util.ArrayList<IController>	getAllEntities() Returns a list of all related entities.
IController	getController() Getter method for the controller.
java.util.Map<IMeshCategory,java.util.ArrayList<IController>>	getEntities() Get the entities map in the form of an array of map entries.
java.util.ArrayList<IController>	getEntitiesFromCategory(IMeshCategory category) Return all of the part's children entities of a 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.
java.util.Set<IMeshCategory>	getEntityCategories() Get the set of all categories in the mesh's entities map.
java.util.Map<IMeshProperty,java.lang.String>	getProperties() Get the properties map in the form of an array of map entries.
java.lang.String	getProperty(IMeshProperty property) Return the value of the given property
java.util.Map<IMeshProperty,java.lang.String>	getPropertyMap() Get the entire properties map for the mesh.
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() Getter function for the part's transformation.
double[]	getTranslation() Get the part's translation in the x, y, and z directions
MeshType	getType() Getter method for type.
int	hashCode()
void	register(IManagedUpdateableListener listener) Register a listener to receive managed updates.
void	removeEntity(IController entity) Removes the given entity from the part's children
void	setController(IController controller) Setter method for the controller.
void	setEntities(java.util.Map<IMeshCategory,java.util.ArrayList<IController>> 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, creating it in the map if it is not already present.
void	setTransformation(Transformation newTransformation) Setter function for the part's transformation.
void	setType(MeshType type) Setter method for the mesh's type
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

BasicMesh

public BasicMesh()

The default constructor

BasicMesh

public BasicMesh(MeshType type)

A constructor allowing the user to specify the mesh's type.

Parameters:

type - The type of mesh this component models.

BasicMesh

public BasicMesh(java.util.List<IController> entities)

A constructor which provides a set of child entities for the MeshComponent.

Parameters:

entities - The list of initial entities.

BasicMesh

public BasicMesh(java.util.ArrayList<IController> entities,
                 MeshType type)

A constructor which provides a set of child entities and a mesh type

Parameters:

entities - The list of initial entities

type - The mesh's type

BasicMesh

public BasicMesh(java.util.Map<java.lang.Object,java.lang.Object> input,
                 MeshType type)

A constructor taking a map of input to initialize the MeshComponent. If the type is custom part, then the constructor will take a map of initial properties in the form of a Map keyed on property names. Otherwise, it will take a map of initial entities in the form of a Map> keyed on category names.

Parameters:

input - The map representing the child entities and their categories or properties, according to the component's type.

type - The type of component the mesh represents.

Method Detail

getTransformation

public Transformation getTransformation()

Description copied from interface: IMesh

Getter function for the part's transformation.

Specified by:

getTransformation in interface IMesh

Returns:

The part's current transformation.

getType

public MeshType getType()

Description copied from interface: IMesh

Getter method for type.

Specified by:

getType in interface IMesh

Returns:

The mesh's type

setType

public void setType(MeshType type)

Description copied from interface: IMesh

Setter method for the mesh's type

Specified by:

setType in interface IMesh

getAllEntities

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

Description copied from interface: IMesh

Returns a list of all related entities.

Specified by:

getAllEntities in interface IMesh

Returns:

All related entities.

getEntitiesFromCategory

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

Description copied from interface: IMesh

Return all of the part's children entities of a given category.

Specified by:

getEntitiesFromCategory in interface IMesh

Parameters:

category - The category of entities to return

Returns:

All the entities in the map for the specified category.

getEntitiesFromCategory

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

Description copied from interface: IMesh

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 IMesh

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: IMesh

Return the value of the given property

Specified by:

getProperty in interface IMesh

setProperty

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

Description copied from interface: IMesh

Set the given property, creating it in the map if it is not already present.

Specified by:

setProperty in interface IMesh

getPropertyMap

public java.util.Map<IMeshProperty,java.lang.String> getPropertyMap()

Description copied from interface: IMesh

Get the entire properties map for the mesh.

Specified by:

getPropertyMap in interface IMesh

Returns:

The map of all properties.

addEntity

public void addEntity(IController newEntity)

Description copied from interface: IMesh

Add a new entity to the part. A convenience method which allows for the specification of a default behavior for new entities when no category is specified.

Specified by:

addEntity in interface IMesh

removeEntity

public void removeEntity(IController entity)

Description copied from interface: IMesh

Removes the given entity from the part's children

Specified by:

removeEntity in interface IMesh

addEntityToCategory

public void addEntityToCategory(IController newEntity,
                                IMeshCategory category)

Description copied from interface: IMesh

Adds a new child entity under the given category.

Specified by:

addEntityToCategory in interface IMesh

Parameters:

newEntity - The new child entity to be added

category - The new entity's category

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

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(IMesh otherObject)

Description copied from interface: IMesh

Deep copies the contents of another AbstractMeshComponent into this one. This does not copy the reference to any parent IController, as an IController should have exactly one AbstractMesh as a model.

Specified by:

copy in interface IMesh

Parameters:

otherObject - The object which will be copied into this.

getController

public IController getController()

Description copied from interface: IMesh

Getter method for the controller.

Specified by:

getController in interface IMesh

Returns:

The IController which manages this component

setController

public void setController(IController controller)

Description copied from interface: IMesh

Setter method for the controller.

Specified by:

setController in interface IMesh

Parameters:

controller - The IController which manages this component

setTransformation

public void setTransformation(Transformation newTransformation)

Description copied from interface: IMesh

Setter function for the part's transformation.

Specified by:

setTransformation in interface IMesh

Parameters:

newTransformation - The transformation to apply to this part.

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getEntityCategories

public java.util.Set<IMeshCategory> getEntityCategories()

Description copied from interface: IMesh

Get the set of all categories in the mesh's entities map.

Specified by:

getEntityCategories in interface IMesh

Returns:

The set of all categories in the mesh's entities map.

getEntities

public java.util.Map<IMeshCategory,java.util.ArrayList<IController>> getEntities()

Description copied from interface: IMesh

Get the entities map in the form of an array of map entries. This method is intended for use by the JAXB marshaler.

Specified by:

getEntities in interface IMesh

Returns:

An array of map entries, each with an IMeshCategory and all IControllers in that category.

getProperties

public java.util.Map<IMeshProperty,java.lang.String> getProperties()

Description copied from interface: IMesh

Get the properties map in the form of an array of map entries. This method is inteded for use by the JAXB marshaler. Clients should call getProperyMap() instead.

Specified by:

getProperties in interface IMesh

Returns:

An array of map entries, each with an IMeshProperty and its associated setting.

setEntities

public void setEntities(java.util.Map<IMeshCategory,java.util.ArrayList<IController>> newEntities)

Description copied from interface: IMesh

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 IMesh

setProperties

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

Description copied from interface: IMesh

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

Specified by:

setProperties in interface IMesh

Parameters:

properties - The new map of properties for the mesh.

getRotation

public double[] getRotation()

Description copied from interface: IMesh

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

Specified by:

getRotation in interface IMesh

getScale

public double[] getScale()

Description copied from interface: IMesh

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

Specified by:

getScale in interface IMesh

getSize

public double getSize()

Description copied from interface: IMesh

Get the part's size.

Specified by:

getSize in interface IMesh

getSkew

public double[] getSkew()

Description copied from interface: IMesh

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

Specified by:

getSkew in interface IMesh

getTranslation

public double[] getTranslation()

Description copied from interface: IMesh

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

Specified by:

getTranslation in interface IMesh