AxesPrimitive

java.lang.Object
- agi.foundation.graphics.Primitive
- - agi.foundation.graphics.AxesPrimitive

All Implemented Interfaces:

IDisposable, AutoCloseable
```
public final class AxesPrimitive
extends Primitive
implements IDisposable
```
Renders an axes in the 3D scene.

Constructor Summary

Constructors
Constructor and Description
`AxesPrimitive(ReferenceFrame sys, Axes axes, GraphicsFont font)` Initializes an axes primitive with the specified ISystem `sys` as its source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`dispose(boolean disposing)`
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`BoundingSphere`	`getBoundingSphere()` Gets the bounding sphere that encompasses the primitive.
`Color`	`getColor()` Gets the primitive's color.
`boolean`	`getDisplayLabel()` Gets or Sets whether the axes' label is displayed.
`boolean`	`getDisplayLines()` Gets or Sets whether persistence lines are displayed.
`boolean`	`getDisplaySweep()` Gets or Sets whether the persistence sweep (triangles) is displayed.
`boolean`	`getDisplayTrace()` Gets or Sets whether the persistence trace (points) is displayed.
`boolean`	`getFadePersistence()` Gets or Sets whether the persistence path should fade over time.
`String`	`getLabel()` Gets or Sets the axes label.
`double`	`getLength()` Gets or Sets the axes' source-to-arrow-tip length.
`boolean`	`getLighting()` Gets or Sets whether the primitive is lit.
`double`	`getPersistenceDuration()` Gets or Sets the maximum length (in seconds) of the persistence path.
`double`	`getPersistenceWidth()` Gets or Sets persistence point/line width.
`double`	`getWidth()` Gets or Sets the width in pixels.
`void`	`setColor(Color value)` Sets the primitive's color.
`void`	`setDisplayCondition(DisplayCondition value)` Sets the display condition that determines if the primitive should be rendered.
`void`	`setDisplayLabel(boolean value)` Gets or Sets whether the axes' label is displayed.
`void`	`setDisplayLines(boolean value)` Gets or Sets whether persistence lines are displayed.
`void`	`setDisplaySweep(boolean value)` Gets or Sets whether the persistence sweep (triangles) is displayed.
`void`	`setDisplayTrace(boolean value)` Gets or Sets whether the persistence trace (points) is displayed.
`void`	`setFadePersistence(boolean value)` Gets or Sets whether the persistence path should fade over time.
`void`	`setLabel(String text)` Gets or Sets the axes label.
`void`	`setLength(double length)` Gets or Sets the axes' source-to-arrow-tip length.
`void`	`setLighting(boolean value)` Gets or Sets whether the primitive is lit.
`void`	`setPersistenceDuration(double value)` Gets or Sets the maximum length (in seconds) of the persistence path.
`void`	`setPersistenceWidth(double persistenceLineWidth)` Gets or Sets persistence point/line width.
`void`	`setReferenceFrame(ReferenceFrame value)` Sets the reference frame this primitive is defined and rendered in.
`void`	`setTranslucency(float value)` Sets the primitive's translucency.
`void`	`setWidth(double thickness)` Gets or Sets the width in pixels.

Methods inherited from class agi.foundation.graphics.Primitive
dispose, getAutomaticallyComputeBoundingSphere, getDisplay, getDisplayCondition, getReferenceFrame, getTag, getTranslucency, setAutomaticallyComputeBoundingSphere, setBoundingSphere, setDisplay, setTag

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable
close, dispose

- Constructor Detail
  - AxesPrimitive
```
public AxesPrimitive(ReferenceFrame sys,
                     Axes axes,
                     GraphicsFont font)
```
    Initializes an axes primitive with the specified ISystem sys as its source.
    The primitive's properties are initialized to the following values:
    - agi.foundation.graphics.primitive.ReferenceFrame: sys
    - agi.foundation.graphics.primitive.Translucency: 0.0f
    - DisplayLabel: false
    - DisplayTrace: false
    - DisplaySweep: false
    - DisplayLines: false
    - FadePersistence: false
    Once the primitive is constructed, it must be added to Primitives (get) before it will be rendered.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: java.lang.Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - the Exception raised by this method
    
    See Also:
    
    WeakReference, PhantomReference
  - dispose
```
protected void dispose(boolean disposing)
```
    Overrides:
    
    dispose in class Primitive
  - getLighting
```
public final boolean getLighting()
```
    Gets or Sets whether the primitive is lit.
  - setLighting
```
public final void setLighting(boolean value)
```
    Gets or Sets whether the primitive is lit.
  - getLabel
```
public final String getLabel()
```
    Gets or Sets the axes label.
    
    See Also:
    
    DisplayLabel
  - setLabel
```
public final void setLabel(String text)
```
    Gets or Sets the axes label.
    
    See Also:
    
    DisplayLabel
  - getDisplayLabel
```
public final boolean getDisplayLabel()
```
    Gets or Sets whether the axes' label is displayed.
    
    See Also:
    
    Label
  - setDisplayLabel
```
public final void setDisplayLabel(boolean value)
```
    Gets or Sets whether the axes' label is displayed.
    
    See Also:
    
    Label
  - getDisplayTrace
```
public final boolean getDisplayTrace()
```
    Gets or Sets whether the persistence trace (points) is displayed.
    
    See Also:
    
    DisplaySweep, DisplayLines, PersistenceWidth, FadePersistence, PersistenceDuration
  - setDisplayTrace
```
public final void setDisplayTrace(boolean value)
```
    Gets or Sets whether the persistence trace (points) is displayed.
    
    See Also:
    
    DisplaySweep, DisplayLines, PersistenceWidth, FadePersistence, PersistenceDuration
  - getDisplaySweep
```
public final boolean getDisplaySweep()
```
    Gets or Sets whether the persistence sweep (triangles) is displayed.
    
    See Also:
    
    DisplayTrace, DisplayLines, FadePersistence, PersistenceDuration
  - setDisplaySweep
```
public final void setDisplaySweep(boolean value)
```
    Gets or Sets whether the persistence sweep (triangles) is displayed.
    
    See Also:
    
    DisplayTrace, DisplayLines, FadePersistence, PersistenceDuration
  - getDisplayLines
```
public final boolean getDisplayLines()
```
    Gets or Sets whether persistence lines are displayed.
    
    See Also:
    
    DisplayTrace, DisplaySweep, PersistenceWidth, FadePersistence, PersistenceDuration
  - setDisplayLines
```
public final void setDisplayLines(boolean value)
```
    Gets or Sets whether persistence lines are displayed.
    
    See Also:
    
    DisplayTrace, DisplaySweep, PersistenceWidth, FadePersistence, PersistenceDuration
  - getPersistenceWidth
```
public final double getPersistenceWidth()
```
    Gets or Sets persistence point/line width.
    
    See Also:
    
    DisplayTrace, DisplayLines
  - setPersistenceWidth
```
public final void setPersistenceWidth(double persistenceLineWidth)
```
    Gets or Sets persistence point/line width.
    
    See Also:
    
    DisplayTrace, DisplayLines
  - getFadePersistence
```
public final boolean getFadePersistence()
```
    Gets or Sets whether the persistence path should fade over time.
    
    See Also:
    
    DisplayTrace, DisplaySweep, DisplayLines, PersistenceDuration
  - setFadePersistence
```
public final void setFadePersistence(boolean value)
```
    Gets or Sets whether the persistence path should fade over time.
    
    See Also:
    
    DisplayTrace, DisplaySweep, DisplayLines, PersistenceDuration
  - getPersistenceDuration
```
public final double getPersistenceDuration()
```
    Gets or Sets the maximum length (in seconds) of the persistence path.
    
    See Also:
    
    DisplayTrace, DisplaySweep, DisplayLines, FadePersistence
  - setPersistenceDuration
```
public final void setPersistenceDuration(double value)
```
    Gets or Sets the maximum length (in seconds) of the persistence path.
    
    See Also:
    
    DisplayTrace, DisplaySweep, DisplayLines, FadePersistence
  - getLength
```
public final double getLength()
```
    Gets or Sets the axes' source-to-arrow-tip length.
  - setLength
```
public final void setLength(double length)
```
    Gets or Sets the axes' source-to-arrow-tip length.
  - getWidth
```
public final double getWidth()
```
    Gets or Sets the width in pixels. As the camera distances changes from this primitive, the geometry will autoscale to maintain this thickness.
    
    See Also:
    
    Length
  - setWidth
```
public final void setWidth(double thickness)
```
    Gets or Sets the width in pixels. As the camera distances changes from this primitive, the geometry will autoscale to maintain this thickness.
    
    See Also:
    
    Length
  - setReferenceFrame
```
public void setReferenceFrame(ReferenceFrame value)
```
    Description copied from class: Primitive
    
    Sets the reference frame this primitive is defined and rendered in.
    
    Overrides:
    
    setReferenceFrame in class Primitive
  - getColor
```
public Color getColor()
```
    Description copied from class: Primitive
    
    Gets the primitive's color.
    
    Overrides:
    
    getColor in class Primitive
  - setColor
```
public void setColor(Color value)
```
    Description copied from class: Primitive
    
    Sets the primitive's color.
    
    Overrides:
    
    setColor in class Primitive
  - getBoundingSphere
```
public BoundingSphere getBoundingSphere()
```
    Description copied from class: Primitive
    
    Gets the bounding sphere that encompasses the primitive. The center is defined in the primitive's ReferenceFrame.
    
    Overrides:
    
    getBoundingSphere in class Primitive
  - setDisplayCondition
```
public void setDisplayCondition(DisplayCondition value)
```
    Description copied from class: Primitive
    
    Sets the display condition that determines if the primitive should be rendered. Both this and Display must evaluate to true for the primitive to be rendered.
    When DisplayCondition is null, no display condition is evaluated before the primitive is rendered.
    
    Overrides:
    
    setDisplayCondition in class Primitive
    
    See Also:
    
    Display Conditions topic, DisplayCondition, Display
  - setTranslucency
```
public void setTranslucency(float value)
```
    Description copied from class: Primitive
    
    Sets the primitive's translucency. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Overrides:
    
    setTranslucency in class Primitive

Class AxesPrimitive

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.graphics.Primitive

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

Method Detail

finalize

dispose

getLighting

setLighting

getLabel

setLabel

getDisplayLabel

setDisplayLabel

getDisplayTrace

setDisplayTrace

getDisplaySweep

setDisplaySweep

getDisplayLines

setDisplayLines

getPersistenceWidth

setPersistenceWidth

getFadePersistence

setFadePersistence

getPersistenceDuration

setPersistenceDuration

getLength

setLength

getWidth

setWidth

setReferenceFrame

getColor

setColor

getBoundingSphere

setDisplayCondition

setTranslucency