Package repast.simphony.visualization.engine

Class CartesianDisplayDescriptor

java.lang.Object

repast.simphony.scenario.AbstractDescriptor

repast.simphony.visualization.engine.BasicDisplayDescriptor

repast.simphony.visualization.engine.CartesianDisplayDescriptor

All Implemented Interfaces:

Descriptor, DisplayDescriptor, ValueLayerDescriptor

public class CartesianDisplayDescriptor
extends BasicDisplayDescriptor
implements ValueLayerDescriptor

Display descriptor for Cartesian (2D,3D) displays with value layers. TODO Projections: also implement network descriptor?

Author:

Nick Collier, Eric Tatara

Field Summary

Fields

Modifier and Type	Field	Description
List<String>	valueLayers

Fields inherited from class repast.simphony.scenario.AbstractDescriptor

scs

Constructor Summary

Constructors

Constructor	Description
CartesianDisplayDescriptor(String name)
CartesianDisplayDescriptor(CartesianDisplayDescriptor descriptor)

Method Summary

Modifier and Type	Method	Description
void	addValueLayerName(String name)	Adds the named value layer to the list of value layers to display.
void	clearValueLayerNames()
int	getValueLayerCount()	Gets the number of Value Layers in this display descriptor.
String	getValueLayerEditedStyleName()	Gets the name of the value layer edited style.
Iterable<String>	getValueLayerNames()	Gets a List of all the names of the value layers to display.
String	getValueLayerStyleName()	Gets the name of the value layer style.
DisplayDescriptor	makeCopy()	Returns a deep copy of the descriptor.
void	set(DisplayDescriptor descriptor)	Sets the fields of this descriptor from another when making copies.
void	setValueLayerEditedStyleName(String name)	Sets the value layer edited style name.
void	setValueLayerStyleName(String name)	Sets the value layer style name.

Methods inherited from class repast.simphony.visualization.engine.BasicDisplayDescriptor

addEditedStyle, addLayerOrder, addNetworkEditedStyle, addNetworkStyle, addProjection, addStyle, agentClassEditedStyleNames, agentClassLayerOrders, agentClassStyleNames, clearProjectionDescriptors, clearProjections, getBackgroundColor, getBoundingBox, getDefaultNetStyles, getDefaultStyles, getDisplayType, getEditedStyleName, getEditedStyles, getLayerOrder, getLayerOrders, getLayoutClassName, getLayoutFrqeuency, getLayoutInterval, getLayoutProjection, getLayoutProperties, getNetworkEditedStyleName, getNetworkStyleClassName, getProjectionCount, getProjectionDescriptor, getProjectionDescriptors, getProjections, getProperty, getScheduleParameters, getStyleClassName, getStyles, networkEditedStyleIDs, networkStyleIDs, propertyNames, setBackgroundColor, setBoundingBox, setDisplayType, setLayoutClassName, setLayoutFrequency, setLayoutInterval, setLayoutProjection, setLayoutProperties, setProperty, setScheduleParameters

Methods inherited from class repast.simphony.scenario.AbstractDescriptor

addScenarioChangedListener, getName, readResolve, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface repast.simphony.engine.schedule.Descriptor

getName, setName

Methods inherited from interface repast.simphony.visualization.engine.DisplayDescriptor

addScenarioChangedListener

Field Details

valueLayers

public List<String> valueLayers

Constructor Details

CartesianDisplayDescriptor

public CartesianDisplayDescriptor(CartesianDisplayDescriptor descriptor)

CartesianDisplayDescriptor

public CartesianDisplayDescriptor(String name)

Method Details

clearValueLayerNames

public void clearValueLayerNames()

Specified by:

clearValueLayerNames in interface ValueLayerDescriptor

getValueLayerCount

public int getValueLayerCount()

Description copied from interface: ValueLayerDescriptor

Gets the number of Value Layers in this display descriptor.

Specified by:

getValueLayerCount in interface ValueLayerDescriptor

Returns:

set

public void set(DisplayDescriptor descriptor)

Description copied from class: BasicDisplayDescriptor

Sets the fields of this descriptor from another when making copies.

Specified by:

set in interface DisplayDescriptor

Overrides:

set in class BasicDisplayDescriptor

addValueLayerName

public void addValueLayerName(String name)

Adds the named value layer to the list of value layers to display.

Specified by:

addValueLayerName in interface ValueLayerDescriptor

Parameters:

name - the name of the value layer to display.

getValueLayerNames

public Iterable<String> getValueLayerNames()

Gets a List of all the names of the value layers to display.

Specified by:

getValueLayerNames in interface ValueLayerDescriptor

Returns:

a List of all the names of the value layers to display.

setValueLayerStyleName

public void setValueLayerStyleName(String name)

Sets the value layer style name.

Specified by:

setValueLayerStyleName in interface ValueLayerDescriptor

Parameters:

name -

getValueLayerStyleName

public String getValueLayerStyleName()

Gets the name of the value layer style. Will return null if no value layer style has been selected.

Specified by:

getValueLayerStyleName in interface ValueLayerDescriptor

Returns:

the name of the value layer style.

getValueLayerEditedStyleName

public String getValueLayerEditedStyleName()

Gets the name of the value layer edited style. Will return null if no value layer style has been selected.

Specified by:

getValueLayerEditedStyleName in interface ValueLayerDescriptor

Returns:

the name of the value layer edited style.

setValueLayerEditedStyleName

public void setValueLayerEditedStyleName(String name)

Sets the value layer edited style name.

Specified by:

setValueLayerEditedStyleName in interface ValueLayerDescriptor

Parameters:

name -

makeCopy

public DisplayDescriptor makeCopy()

Description copied from interface: DisplayDescriptor

Returns a deep copy of the descriptor.

Specified by:

makeCopy in interface DisplayDescriptor

Returns: