agi.foundation.platforms

(agi.foundation.platforms.graphics-2024r2.jar)

Class DisplayParameters

java.lang.Object

agi.foundation.platforms.DisplayParameters

public class DisplayParameters
extends Object

Defines parameters for determining when an object should be drawn in a Scene

Constructor Summary

Constructors

Constructor and Description
DisplayParameters()

Method Summary

Modifier and Type	Method and Description
GraphicsParameter<Boolean>	getDisplay() Gets the parameter indicating when the object should be displayed.
GraphicsParameter<Double>	getMaximumDistance() Gets the parameter indicating the maximum distance from the Camera that the object can be and still be drawn.
GraphicsParameter<Integer>	getMaximumPixelSize() Gets the parameter indicating the maximum pixel size that the object can be and still be drawn.
GraphicsParameter<Double>	getMinimumDistance() Gets the parameter indicating the minimum distance from the Camera that the object must be before it is drawn.
GraphicsParameter<Integer>	getMinimumPixelSize() Gets the minimum pixel size the object must be in order to be drawn.
GraphicsParameter<Iterable<Scene>>	getScenes() Gets the the parameter indicating the list of Scenes that the object should be displayed in.
void	setDisplay(GraphicsParameter<Boolean> value) Sets the parameter indicating when the object should be displayed.
void	setMaximumDistance(GraphicsParameter<Double> value) Sets the parameter indicating the maximum distance from the Camera that the object can be and still be drawn.
void	setMaximumPixelSize(GraphicsParameter<Integer> value) Sets the parameter indicating the maximum pixel size that the object can be and still be drawn.
void	setMinimumDistance(GraphicsParameter<Double> value) Sets the parameter indicating the minimum distance from the Camera that the object must be before it is drawn.
void	setMinimumPixelSize(GraphicsParameter<Integer> value) Sets the minimum pixel size the object must be in order to be drawn.
void	setScenes(GraphicsParameter<Iterable<Scene>> value) Sets the the parameter indicating the list of Scenes that the object should be displayed in.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayParameters

public DisplayParameters()

Method Detail

getDisplay

public final GraphicsParameter<Boolean> getDisplay()

Gets the parameter indicating when the object should be displayed.

setDisplay

public final void setDisplay(GraphicsParameter<Boolean> value)

Sets the parameter indicating when the object should be displayed.

getScenes

public final GraphicsParameter<Iterable<Scene>> getScenes()

Gets the the parameter indicating the list of Scenes that the object should be displayed in. Leaving this property null will cause the object to be displayed in all scenes.

setScenes

public final void setScenes(GraphicsParameter<Iterable<Scene>> value)

Sets the the parameter indicating the list of Scenes that the object should be displayed in. Leaving this property null will cause the object to be displayed in all scenes.

getMinimumPixelSize

public final GraphicsParameter<Integer> getMinimumPixelSize()

Gets the minimum pixel size the object must be in order to be drawn.

setMinimumPixelSize

public final void setMinimumPixelSize(GraphicsParameter<Integer> value)

Sets the minimum pixel size the object must be in order to be drawn.

getMaximumPixelSize

public final GraphicsParameter<Integer> getMaximumPixelSize()

Gets the parameter indicating the maximum pixel size that the object can be and still be drawn.

setMaximumPixelSize

public final void setMaximumPixelSize(GraphicsParameter<Integer> value)

Sets the parameter indicating the maximum pixel size that the object can be and still be drawn.

getMinimumDistance

public final GraphicsParameter<Double> getMinimumDistance()

Gets the parameter indicating the minimum distance from the Camera that the object must be before it is drawn.

setMinimumDistance

public final void setMinimumDistance(GraphicsParameter<Double> value)

Sets the parameter indicating the minimum distance from the Camera that the object must be before it is drawn.

getMaximumDistance

public final GraphicsParameter<Double> getMaximumDistance()

Gets the parameter indicating the maximum distance from the Camera that the object can be and still be drawn.

setMaximumDistance

public final void setMaximumDistance(GraphicsParameter<Double> value)

Sets the parameter indicating the maximum distance from the Camera that the object can be and still be drawn.