Package repast.simphony.visualization.engine

Interface ProjectionDescriptor

All Known Implementing Classes:

AbstractProjectionDescriptor, ContinuousProjectionDescriptor, DefaultProjectionDescriptor, GisProjectionDescriptor, GridProjectionDescriptor

public interface ProjectionDescriptor

Interface for classes that describe how a projection should be visualized. TODO Projections: We don't really need to have this interface provide the "implied" layout class since the DisplayDescritor has an essentially unused entry for the layout!

Version:

$Revision$ $Date$

Author:

Nick Collier

Method Summary

Modifier and Type	Method	Description
Iterable<ProjectionDecorator2D>	get2DDecorators()	Gets an Iterable over the 2d projection decorators for the projection.
Iterable<ProjectionDecorator3D>	get3DDecorators()	Gets an Iterable over the 3d projection decorators for the projection.
String	getImpliedLayout2D()	Gets the implied 2d layout of the projection, if any.
String	getImpliedLayout3D()	Gets the implied 3d layout of the projection, if any.
String	getProjectionName()	Gets the name of the projection.
Object	getProperty(String groupID, String key)	Gets the named property in the specified property group.
void	registerProjectionData(ProjectionData data, DisplayDescriptor descriptor)	Register ProjectionData with the DisplayDescriptor.
void	setProperty(String groupID, String key, Object value)	Sets the named property in the specified property group.

Method Detail

registerProjectionData

void registerProjectionData(ProjectionData data,
                            DisplayDescriptor descriptor)

Register ProjectionData with the DisplayDescriptor. This is implemented here since different ProjectionDescriptor implementations might handle psuedo-projections like value layers differently from actual Projection implementations.

Parameters:

data - the ProjectionData to register with the DisplayDescriptor

descriptor - the DisplayDescriptor

getProjectionName

String getProjectionName()

Gets the name of the projection.

Returns:

the name of the projection.

setProperty

void setProperty(String groupID,
                 String key,
                 Object value)

Sets the named property in the specified property group. For example, each kind of decorator would have its own properties and these would be grouped into a property group.

Parameters:

groupID -

key -

value -

getProperty

Object getProperty(String groupID,
                   String key)

Gets the named property in the specified property group. For example, each kind of decorator would have its own properties and these would be grouped into a property group.

Parameters:

groupID -

key -

Returns:

the named property in the specified property group.

get3DDecorators

Iterable<ProjectionDecorator3D> get3DDecorators()

Gets an Iterable over the 3d projection decorators for the projection.

Returns:

an Iterable over the 3d projection decorators for the projection.

get2DDecorators

Iterable<ProjectionDecorator2D> get2DDecorators()

Gets an Iterable over the 2d projection decorators for the projection.

Returns:

an Iterable over the 2d projection decorators for the projection.

getImpliedLayout3D

String getImpliedLayout3D()

Gets the implied 3d layout of the projection, if any. For example, a grid projection implies a grid layout.

Returns:

the implied layout of the projection, if any.

getImpliedLayout2D

String getImpliedLayout2D()

Gets the implied 2d layout of the projection, if any. For example, a grid projection implies a grid layout.

Returns:

the implied layout of the projection, if any.