ucl.physiol.neuroconstruct.utils
Class Display3DProperties

java.lang.Object
  ucl.physiol.neuroconstruct.utils.Display3DProperties

public class Display3DProperties
extends Object

Storing of various properties related to how the cells should be displayed in 3D

Author:

Padraig Gleeson

Field Summary

static int	AA_NOT_SET
static int	AA_OFF
static int	AA_ON
static String	DISPLAY_INPUTS_AS_PROBES
static String	DISPLAY_INPUTS_AS_SPHERES
static String	DISPLAY_SOMA_LINE_NEURITE_LINE
static String	DISPLAY_SOMA_NEURITE_SOLID
static String	DISPLAY_SOMA_NEURITE_SOLID_UNSHINY
static String	DISPLAY_SOMA_SOLID_NEURITE_LINE
static String	DISPLAY_SOMA_SOLID_NEURITE_NONE

Constructor Summary

Display3DProperties()

Display3DProperties(Color backgroundColour3D, Color cellColour3D, boolean show3DAxes, boolean showRegions, boolean showInputs, boolean showAxonalArbours, boolean showSynapseConns, boolean showSynapseEndpoints, int antiAliasing, String dendriteDisplayOption, float transparency)

Method Summary

int	getAntiAliasing()
Color	getBackgroundColour3D()
Color	getCellColour3D()
String	getDisplayOption() How to display the dendrites, etc.
static Vector	getDisplayOptions(boolean inclComps) Get allowable display formats
float	getMinRadius()
int	getResolution3DElements()
boolean	getShow3DAxes()
boolean	getShowAxonalArbours()
boolean	getShowInputs()
String	getShowInputsAs()
boolean	getShowRegions()
boolean	getShowSynapseConns()
boolean	getShowSynapseEndpoints()
float	getTransparency()
void	initialiseDefaultValues() Gets the defaults from GeneralProperties.
boolean	isCompartmentalisationDisplay() Returns wether this display is not of the original cell, but a compartmentalisation
void	setAntiAliasing(int antiAliasing)
void	setBackgroundColour3D(Color colour)
void	setCellColour3D(Color cellColour3D)
void	setDisplayOption(String dispOpt) How to display the dendrites, etc.
void	setMinRadius(float minRadius)
void	setResolution3DElements(int resolution3DElements)
void	setShow3DAxes(boolean showAxes)
void	setShowAxonalArbours(boolean show)
void	setShowInputs(boolean show)
void	setShowInputsAs(String showAs)
void	setShowRegions(boolean show)
void	setShowSynapseConns(boolean show)
void	setShowSynapseEndpoints(boolean show)
void	setTransparency(float transparency)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_SOMA_NEURITE_SOLID

public static final String DISPLAY_SOMA_NEURITE_SOLID

See Also:

Constant Field Values

DISPLAY_SOMA_NEURITE_SOLID_UNSHINY

public static final String DISPLAY_SOMA_NEURITE_SOLID_UNSHINY

See Also:

Constant Field Values

DISPLAY_SOMA_SOLID_NEURITE_NONE

public static final String DISPLAY_SOMA_SOLID_NEURITE_NONE

See Also:

Constant Field Values

DISPLAY_SOMA_SOLID_NEURITE_LINE

public static final String DISPLAY_SOMA_SOLID_NEURITE_LINE

See Also:

Constant Field Values

DISPLAY_SOMA_LINE_NEURITE_LINE

public static final String DISPLAY_SOMA_LINE_NEURITE_LINE

See Also:

Constant Field Values

DISPLAY_INPUTS_AS_PROBES

public static final String DISPLAY_INPUTS_AS_PROBES

See Also:

Constant Field Values

DISPLAY_INPUTS_AS_SPHERES

public static final String DISPLAY_INPUTS_AS_SPHERES

See Also:

Constant Field Values

AA_NOT_SET

public static final int AA_NOT_SET

See Also:

Constant Field Values

AA_OFF

public static final int AA_OFF

See Also:

Constant Field Values

AA_ON

public static final int AA_ON

See Also:

Constant Field Values

Constructor Detail

Display3DProperties

public Display3DProperties()

Display3DProperties

public Display3DProperties(Color backgroundColour3D,
                           Color cellColour3D,
                           boolean show3DAxes,
                           boolean showRegions,
                           boolean showInputs,
                           boolean showAxonalArbours,
                           boolean showSynapseConns,
                           boolean showSynapseEndpoints,
                           int antiAliasing,
                           String dendriteDisplayOption,
                           float transparency)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

initialiseDefaultValues

public void initialiseDefaultValues()

Gets the defaults from GeneralProperties. This is put in a separate function (a.o.t the constructor) to allow the XMLEncoder to record the correct values at the time of saving

getDisplayOptions

public static Vector getDisplayOptions(boolean inclComps)

Get allowable display formats

Parameters:

inclComps - include compartmentalisation options

getTransparency

public float getTransparency()

setTransparency

public void setTransparency(float transparency)

getBackgroundColour3D

public Color getBackgroundColour3D()

setBackgroundColour3D

public void setBackgroundColour3D(Color colour)

getShow3DAxes

public boolean getShow3DAxes()

setShow3DAxes

public void setShow3DAxes(boolean showAxes)

getAntiAliasing

public int getAntiAliasing()

setAntiAliasing

public void setAntiAliasing(int antiAliasing)

getShowInputs

public boolean getShowInputs()

getShowInputsAs

public String getShowInputsAs()

setShowInputs

public void setShowInputs(boolean show)

setShowInputsAs

public void setShowInputsAs(String showAs)

getShowAxonalArbours

public boolean getShowAxonalArbours()

setShowAxonalArbours

public void setShowAxonalArbours(boolean show)

getDisplayOption

public String getDisplayOption()

How to display the dendrites, etc. sticks or with diameters

isCompartmentalisationDisplay

public boolean isCompartmentalisationDisplay()

Returns wether this display is not of the original cell, but a compartmentalisation

setDisplayOption

public void setDisplayOption(String dispOpt)

How to display the dendrites, etc. sticks or with diameters

getShowRegions

public boolean getShowRegions()

setShowRegions

public void setShowRegions(boolean show)

getShowSynapseConns

public boolean getShowSynapseConns()

setShowSynapseConns

public void setShowSynapseConns(boolean show)

getShowSynapseEndpoints

public boolean getShowSynapseEndpoints()

setShowSynapseEndpoints

public void setShowSynapseEndpoints(boolean show)

getResolution3DElements

public int getResolution3DElements()

setResolution3DElements

public void setResolution3DElements(int resolution3DElements)

getMinRadius

public float getMinRadius()

setMinRadius

public void setMinRadius(float minRadius)

getCellColour3D

public Color getCellColour3D()

setCellColour3D

public void setCellColour3D(Color cellColour3D)