A PluginParameter that holds a double value. More...

Inheritance diagram for net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
	DoubleParameter ()
	Creates a new instance. More...

double	getMax ()
	Returns the maximal allowed value. More...

double	getMin ()
	Returns the minimal allowed value. More...

String	getParameterType ()

String	getStringValue ()

void	setMax (final double max)
	Sets the maximal allowed value. More...

void	setMin (final double min)
	Sets the minimal allowed value. More...

boolean	setStringValue (@NotNull final String stringValue)

void	setValue (@NotNull final Double value)

Public Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Double >
V	getValue ()

V	getValueOrNull ()

void	setValue ( @NotNull final V value)
	Updates the parameter value. More...

Static Public Attributes
static final String	PARAMETER_TYPE = Double.class.getName()
	The string representation of this parameter type. More...

Private Attributes
double	max = 1.0
	The maximal allowed value. More...

double	min
	The minimal allowed value. More...

Additional Inherited Members
Protected Member Functions inherited from net.sf.gridarta.plugin.parameter.AbstractValuePluginParameter< G, A, R, Double >
	AbstractValuePluginParameter ( @NotNull final V value)
	Creates a new instance. More...

Detailed Description

A PluginParameter that holds a double value.

Definition at line 30 of file DoubleParameter.java.

Constructor & Destructor Documentation

◆ DoubleParameter()

net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.DoubleParameter ( )

Creates a new instance.

Definition at line 53 of file DoubleParameter.java.

Member Function Documentation

◆ getMax()

double net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMax ( )

Returns the maximal allowed value.

Returns: the maximal allowed value

Definition at line 104 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleFromXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleFromXml2(), and net.sf.gridarta.gui.dialog.plugin.parameter.DoubleParameterView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateTooltip().

Here is the caller graph for this function:

◆ getMin()

double net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMin ( )

Returns the minimal allowed value.

Returns: the minimal allowed value

Definition at line 128 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleFromXml1(), net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleFromXml2(), and net.sf.gridarta.gui.dialog.plugin.parameter.DoubleParameterView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateTooltip().

Here is the caller graph for this function:

◆ getParameterType()

String net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameterType ( )

Definition at line 90 of file DoubleParameter.java.

◆ getStringValue()

String net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getStringValue ( )

Definition at line 96 of file DoubleParameter.java.

◆ setMax()

void net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMax ( final double max )

Sets the maximal allowed value.

Parameters

max	the maximal allowed value

Definition at line 112 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleToXml2().

Here is the caller graph for this function:

◆ setMin()

void net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMin ( final double min )

Sets the minimal allowed value.

Parameters

min	the minimal allowed value

Definition at line 136 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleToXml2().

Here is the caller graph for this function:

◆ setStringValue()

boolean net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setStringValue ( @NotNull final String stringValue )

Definition at line 64 of file DoubleParameter.java.

◆ setValue()

void net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setValue ( @NotNull final Double value )

Definition at line 84 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.setMax(), net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.setMin(), net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.setStringValue(), and net.sf.gridarta.plugin.parameter.PluginParameterCodecTest.testDoubleToXml2().

Here is the caller graph for this function:

Member Data Documentation

◆ max

double net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.max = 1.0

private

The maximal allowed value.

We do not use the Double#MAX_VALUE or the

JTextField

will be very large. So we fall back to [0, 1] range (useful for randoms).

Definition at line 48 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.getMax().

◆ min

double net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.min

private

The minimal allowed value.

Definition at line 41 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.getMin(), and net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.setValue().

◆ PARAMETER_TYPE

final String net.sf.gridarta.plugin.parameter.DoubleParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.PARAMETER_TYPE = Double.class.getName()

static

The string representation of this parameter type.

Definition at line 36 of file DoubleParameter.java.

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.createParameter(), net.sf.gridarta.plugin.parameter.DoubleParameter< G, A, R >.getParameterType(), and net.sf.gridarta.plugin.parameter.PluginParameterFactory< G, A, R >.getTypes().

The documentation for this class was generated from the following file:

gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/parameter/DoubleParameter.java

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DoubleParameter()

Member Function Documentation

◆ getMax()

◆ getMin()

◆ getParameterType()

◆ getStringValue()

◆ setMax()

◆ setMin()

◆ setStringValue()

◆ setValue()

Member Data Documentation

◆ max

◆ min

◆ PARAMETER_TYPE