ProjectedRaster

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

All Implemented Interfaces:

IDisposable, AutoCloseable
```
public final class ProjectedRaster
extends Primitive
implements IDisposable
```
A Primitive which projects a Raster onto the terrain or surface of the CentralBody. The ProjectedRaster can also be used with RasterStream and ProjectionStream to stream video and other raster data to a projection that moves with time.

See Also:

Projection, ProjectionStream, Raster, RasterStream, Raster and Projection Streams topic

Constructor Summary

Constructors
Constructor and Description

ProjectedRaster(CentralBody projectionCentralBody)
Initializes a new instance.

Constructors
Constructor and Description
`ProjectedRaster(CentralBody projectionCentralBody)` Initializes a new instance.

Method Summary

All Methods Static 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.
`Color`	`getBorderColor()` Gets the color of the `Projection's` border.
`float`	`getBorderTranslucency()` Gets the translucency of the `Projection's` border.
`float`	`getBorderWidth()` Gets the width of the `Projection's` border.
`Color`	`getColor()` This method is not supported by ProjectedRaster.
`BaseCollection<UnitCartesian>`	`getDirections()` Gets the direction vectors in the projection's reference frame that define the `Projection's` frustum.
`float`	`getFarPlaneTranslucency()` Gets the translucency of the `Projection's` far plane.
`Color`	`getFrustumColor()` Gets the color of the `Projection's` frustum.
`float`	`getFrustumTranslucency()` Gets the translucency of the `Projection's` frustum.
`Projection`	`getProjection()` Gets the `Projection` that projects the `raster.`
`Raster`	`getRaster()` Gets the `Raster` that is `projected.`
`ReferenceFrame`	`getReferenceFrame()` Gets the reference frame that the `Projection` is defined in.
`ProjectedRasterRenderPass`	`getRenderPass()` Gets the pass during which the projected raster is rendered.
`Color`	`getShadowColor()` Gets the color of projection shadows.
`float`	`getShadowTranslucency()` Gets the translucency of the projection shadows.
`boolean`	`getShowFarPlane()` Gets whether to show the far plane of the `Projection`.
`boolean`	`getShowFrustum()` Gets whether to show the frustum of the `Projection`.
`boolean`	`getShowShadows()` Gets whether to show shadows or not.
`static boolean`	`getSupported()` Gets whether the video card supports the `ProjectedRaster`.
`float`	`getTranslucency()` Gets the translucency of the `Projection`.
`void`	`setBorderColor(Color value)` Sets the color of the `Projection's` border.
`void`	`setBorderTranslucency(float value)` Sets the translucency of the `Projection's` border.
`void`	`setBorderWidth(float value)` Sets the width of the `Projection's` border.
`void`	`setColor(Color value)` This method is not supported by ProjectedRaster.
`void`	`setFarPlaneTranslucency(float value)` Sets the translucency of the `Projection's` far plane.
`void`	`setFrustumColor(Color value)` Sets the color of the `Projection's` frustum.
`void`	`setFrustumTranslucency(float value)` Sets the translucency of the `Projection's` frustum.
`void`	`setProjection(Projection value)` Sets the `Projection` that projects the `raster.`
`void`	`setRaster(Raster value)` Sets the `Raster` that is `projected.`
`void`	`setReferenceFrame(ReferenceFrame value)` Sets the reference frame that the `Projection` is defined in.
`void`	`setRenderPass(ProjectedRasterRenderPass renderPass)` Sets the pass during which the projected raster is rendered.
`void`	`setShadowColor(Color value)` Sets the color of projection shadows.
`void`	`setShadowTranslucency(float value)` Sets the translucency of the projection shadows.
`void`	`setShowFarPlane(boolean value)` Sets whether to show the far plane of the `Projection`.
`void`	`setShowFrustum(boolean value)` Sets whether to show the frustum of the `Projection`.
`void`	`setShowShadows(boolean value)` Sets whether to show shadows or not.
`void`	`setTranslucency(float value)` Sets the translucency of the `Projection`.

Methods inherited from class agi.foundation.graphics.Primitive
dispose, getAutomaticallyComputeBoundingSphere, getBoundingSphere, getDisplay, getDisplayCondition, getTag, setAutomaticallyComputeBoundingSphere, setBoundingSphere, setDisplay, setDisplayCondition, 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
  - ProjectedRaster
```
public ProjectedRaster(CentralBody projectionCentralBody)
```
    Initializes a new instance.
    
    Parameters:
    
    projectionCentralBody - The central body that the raster will project onto.
- 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
  - getRaster
```
public final Raster getRaster()
```
    Gets the Raster that is projected.
  - setRaster
```
public final void setRaster(Raster value)
```
    Sets the Raster that is projected.
  - getReferenceFrame
```
public ReferenceFrame getReferenceFrame()
```
    Gets the reference frame that the Projection is defined in.
    
    Overrides:
    
    getReferenceFrame in class Primitive
    
    Throws:
    
    ArgumentNullException - ReferenceFrame is null.
    
    IllegalStateException - Cannot modify ReferenceFrame once the primitive is added to the primitive manager or a composite primitive. Remove the primitive from the manager or composite before modifying ReferenceFrame.
  - setReferenceFrame
```
public void setReferenceFrame(ReferenceFrame value)
```
    Sets the reference frame that the Projection is defined in.
    
    Overrides:
    
    setReferenceFrame in class Primitive
    
    Throws:
    
    ArgumentNullException - ReferenceFrame is null.
    
    IllegalStateException - Cannot modify ReferenceFrame once the primitive is added to the primitive manager or a composite primitive. Remove the primitive from the manager or composite before modifying ReferenceFrame.
  - getProjection
```
public final Projection getProjection()
```
    Gets the Projection that projects the raster.
  - setProjection
```
public final void setProjection(Projection value)
```
    Sets the Projection that projects the raster.
  - getShowFrustum
```
public final boolean getShowFrustum()
```
    Gets whether to show the frustum of the Projection.
    
    See Also:
    
    View Frustum topic
  - setShowFrustum
```
public final void setShowFrustum(boolean value)
```
    Sets whether to show the frustum of the Projection.
    
    See Also:
    
    View Frustum topic
  - getShowFarPlane
```
public final boolean getShowFarPlane()
```
    Gets whether to show the far plane of the Projection. If this is set to true, you will see the projected Raster even when it does not intersect terrain or the central body.
    
    See Also:
    
    View Frustum topic
  - setShowFarPlane
```
public final void setShowFarPlane(boolean value)
```
    Sets whether to show the far plane of the Projection. If this is set to true, you will see the projected Raster even when it does not intersect terrain or the central body.
    
    See Also:
    
    View Frustum topic
  - getShowShadows
```
public final boolean getShowShadows()
```
    Gets whether to show shadows or not. When set to true, the Raster will only be projected onto parts of the terrain visible from the Projection's position. When false, the Raster will project onto any terrain inside the Projection's view frustum. Shadows are more realistic, but are slower to render.
  - setShowShadows
```
public final void setShowShadows(boolean value)
```
    Sets whether to show shadows or not. When set to true, the Raster will only be projected onto parts of the terrain visible from the Projection's position. When false, the Raster will project onto any terrain inside the Projection's view frustum. Shadows are more realistic, but are slower to render.
  - getColor
```
public Color getColor()
```
    This method is not supported by ProjectedRaster.
    
    Overrides:
    
    getColor in class Primitive
    
    Throws:
    
    UnsupportedOperationException - This method is not supported by ProjectedRaster.
  - setColor
```
public void setColor(Color value)
```
    This method is not supported by ProjectedRaster.
    
    Overrides:
    
    setColor in class Primitive
    
    Throws:
    
    UnsupportedOperationException - This method is not supported by ProjectedRaster.
  - getFrustumColor
```
public final Color getFrustumColor()
```
    Gets the color of the Projection's frustum.
  - setFrustumColor
```
public final void setFrustumColor(Color value)
```
    Sets the color of the Projection's frustum.
  - getShadowColor
```
public final Color getShadowColor()
```
    Gets the color of projection shadows.
  - setShadowColor
```
public final void setShadowColor(Color value)
```
    Sets the color of projection shadows.
  - getBorderColor
```
public final Color getBorderColor()
```
    Gets the color of the Projection's border.
  - setBorderColor
```
public final void setBorderColor(Color value)
```
    Sets the color of the Projection's border.
  - getBorderWidth
```
public final float getBorderWidth()
```
    Gets the width of the Projection's border.
  - setBorderWidth
```
public final void setBorderWidth(float value)
```
    Sets the width of the Projection's border.
  - getTranslucency
```
public float getTranslucency()
```
    Gets the translucency of the Projection. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Overrides:
    
    getTranslucency in class Primitive
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - setTranslucency
```
public void setTranslucency(float value)
```
    Sets the translucency of the Projection. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Overrides:
    
    setTranslucency in class Primitive
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - getFrustumTranslucency
```
public final float getFrustumTranslucency()
```
    Gets the translucency of the Projection's frustum. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - setFrustumTranslucency
```
public final void setFrustumTranslucency(float value)
```
    Sets the translucency of the Projection's frustum. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - getFarPlaneTranslucency
```
public final float getFarPlaneTranslucency()
```
    Gets the translucency of the Projection's far plane. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - setFarPlaneTranslucency
```
public final void setFarPlaneTranslucency(float value)
```
    Sets the translucency of the Projection's far plane. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - getBorderTranslucency
```
public final float getBorderTranslucency()
```
    Gets the translucency of the Projection's border. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - setBorderTranslucency
```
public final void setBorderTranslucency(float value)
```
    Sets the translucency of the Projection's border. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - getShadowTranslucency
```
public float getShadowTranslucency()
```
    Gets the translucency of the projection shadows. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - setShadowTranslucency
```
public void setShadowTranslucency(float value)
```
    Sets the translucency of the projection shadows. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
    
    Throws:
    
    ArgumentOutOfRangeException - Translucency must be between 0 and 1.
  - getDirections
```
public final BaseCollection<UnitCartesian> getDirections()
```
    Gets the direction vectors in the projection's reference frame that define the Projection's frustum. The collection contains the direction vector down the center of the projection, and the bottom left, bottom right, upper right, and upper left corner direction vectors, in that order. If no direction can be calculated, Cartesian.Zero is returned.
  - getSupported
```
public static final boolean getSupported()
```
    Gets whether the video card supports the ProjectedRaster.
    
    Returns:
    
    true if the video card supports ProjectedRaster; otherwise, false.
    
    See Also:
    
    System Requirements topic
  - getRenderPass
```
public final ProjectedRasterRenderPass getRenderPass()
```
    Gets the pass during which the projected raster is rendered. Changing the RenderPass is useful when trying to set the rendering order of a projected raster against other primitives in a OrderedCompositePrimitive. Ordering with SurfaceMeshPrimitive requires a render pass of ProjectedRasterRenderPassCentralBodyClipped. Ordering against all other primitives requires a render pass of ProjectedRasterRenderPassTranslucent.
    
    Throws:
    
    UnsupportedCaseException - RenderPass must be a valid value in ProjectedRasterRenderPass.
  - setRenderPass
```
public final void setRenderPass(ProjectedRasterRenderPass renderPass)
```
    Sets the pass during which the projected raster is rendered. Changing the RenderPass is useful when trying to set the rendering order of a projected raster against other primitives in a OrderedCompositePrimitive. Ordering with SurfaceMeshPrimitive requires a render pass of ProjectedRasterRenderPassCentralBodyClipped. Ordering against all other primitives requires a render pass of ProjectedRasterRenderPassTranslucent.
    
    Throws:
    
    UnsupportedCaseException - RenderPass must be a valid value in ProjectedRasterRenderPass.

Class ProjectedRaster

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

getRaster

setRaster

getReferenceFrame

setReferenceFrame

getProjection

setProjection

getShowFrustum

setShowFrustum

getShowFarPlane

setShowFarPlane

getShowShadows

setShowShadows

getColor

setColor

getFrustumColor

setFrustumColor

getShadowColor

setShadowColor

getBorderColor

setBorderColor

getBorderWidth

setBorderWidth

getTranslucency

setTranslucency

getFrustumTranslucency

setFrustumTranslucency

getFarPlaneTranslucency

setFarPlaneTranslucency

getBorderTranslucency

setBorderTranslucency

getShadowTranslucency

setShadowTranslucency

getDirections

getSupported

getRenderPass

setRenderPass