IlvChart3DView (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.chart.IlvChart3DView

All Implemented Interfaces:

Serializable
```
public final class IlvChart3DView
extends Object
implements Serializable
```
Represents the three-dimensional view of a chart.
The IlvChart3DView class lets you control the appearance of an IlvChart when it is drawn in 3-D.

Since:

JViews 5.5

See Also:

IlvChart.is3D(), IlvChart.get3DView(), IlvChart3DViewInteractor, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IlvChart3DView.ZLayer
Holds a set of renderers that are drawn at the same depth.

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlvChart3DView.ZLayer` Holds a set of renderers that are drawn at the same depth.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BACK_WALL` Constant identifying the back wall of a Cartesian chart.
`static int`	`BOTTOM_WALL` Constant identifying the bottom wall of a Cartesian chart.
`static int`	`LEFT_WALL` Constant identifying the left wall of a Cartesian chart.
`static int`	`OBLIQUE` Type constant for oblique projection.
`static int`	`ORTHOGRAPHIC` Type constant for orthographic projection.
`static int`	`RIGHT_WALL` Constant identifying the right wall of a Cartesian chart.
`static int`	`TOP_WALL` Constant identifying the left wall of a Cartesian chart.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener lst)` Adds a listener to listen to the modification of all properties.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener lst)` Adds a listener to listen to the modification of the specified property.
`void`	`draw(Graphics g)` Draws the contents of the 3-D view.
`float`	`getAmbientLight()` Returns the intensity of the ambient light.
`double`	`getBackDepth()` Returns the depth of the back plane (minimum z).
`IlvChart`	`getChart()` Returns the chart associated with the 3-D view.
`int`	`getDepth()` Returns the depth of the chart.
`int`	`getDepthGap()` Returns the depth gap between two consecutive layers along the z-axis.
`double`	`getElevation()` Returns the elevation angle.
`double`	`getFrontDepth()` Returns the depth of the front plane (maximum z).
`double`	`getLightLatitude()` Returns the light latitude.
`double`	`getLightLongitude()` Returns the light longitude.
`int`	`getProjectionType()` Returns the projection type.
`double`	`getRotation()` Returns the rotation angle.
`ilog.views.chart.view3d.IlvChart3DScene`	`getScene()` Internal method.
`IlvLabelRenderer`	`getZAnnotationRenderer()` Returns the renderer used to display the text annotations along the depth axis.
`Paint`	`getZGridPaint()` Returns the paint used to draw the grid lines along the depth axis.
`Stroke`	`getZGridStroke()` Returns the stroke used to draw the grid lines along the depth axis.
`List<IlvChart3DView.ZLayer>`	`getZLayers()` Returns the depth layers.
`double`	`getZoom()` Returns the zooming factor.
`boolean`	`isAutoScaling()` Indicates whether the automatic scaling of the view is active.
`boolean`	`isZAnnotationColorVarying()` Returns `true` if the text annotations along the depth axis take the color of the corresponding data series.
`boolean`	`isZAnnotationVisible()` Indicates whether text annotations are displayed along the depth axis.
`boolean`	`isZGridVisible()` Indicates whether z grid lines are drawn.
`void`	`removePropertyChangeListener(PropertyChangeListener lst)` Removes a listener so that it no longer listens to the modification of the properties.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener lst)` Removes a listener so that it no longer listens to the modification of the specified property.
`void`	`setAmbientLight(float intensity)` Sets the intensity of the ambient light.
`void`	`setAutoScaling(boolean auto)` Toggles the automatic scaling of the view.
`void`	`setDepth(int depth)` Sets the depth of the chart relatively to its width.
`void`	`setDepthGap(int gap)` Sets the depth gap between two consecutive renderers.
`void`	`setElevation(double angle)` Sets the elevation angle.
`void`	`setLightLatitude(double latitude)` Sets the light latitude.
`void`	`setLightLongitude(double longitude)` Sets the light longitude.
`void`	`setProjectionType(int projectionType)` Sets the projection type.
`void`	`setRotation(double angle)` Sets the rotation angle.
`void`	`setViewAngles(double rotation, double elevation)` Sets the view angles.
`void`	`setWallStyle(int mask, IlvStyle style)` Sets the rendering styles for the walls of a 3-D Cartesian chart.
`void`	`setZAnnotationColorVarying(boolean varying)` Specifies whether the text annotations along the depth axis take the color of the corresponding data series, or whether they are all of the same color.
`void`	`setZAnnotationRenderer(IlvLabelRenderer renderer)` Sets the renderer used to display the text annotations along the depth axis.
`void`	`setZAnnotationVisible(boolean visible)` Specifies whether text annotations are displayed along the depth axis.
`void`	`setZGridPaint(Paint paint)` Specifies the paint used to draw the grid lines along the depth axis.
`void`	`setZGridStroke(Stroke stroke)` Specifies the stroke used to draw the grid lines along the depth axis.
`void`	`setZGridVisible(boolean visible)` Specifies whether z grid lines are drawn.
`void`	`setZoom(double zoomFactor)` Sets the zooming factor.
`IlvDoublePoints`	`toDisplay(IlvDoublePoints pts, int yAxis, double z)` Projects the specified points.

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

- Field Detail
  - LEFT_WALL
```
public static final int LEFT_WALL
```
    Constant identifying the left wall of a Cartesian chart.
    
    See Also:
    
    setWallStyle(int, ilog.views.chart.IlvStyle), Constant Field Values
  - RIGHT_WALL
```
public static final int RIGHT_WALL
```
    Constant identifying the right wall of a Cartesian chart.
    
    See Also:
    
    setWallStyle(int, ilog.views.chart.IlvStyle), Constant Field Values
  - TOP_WALL
```
public static final int TOP_WALL
```
    Constant identifying the left wall of a Cartesian chart.
    
    See Also:
    
    setWallStyle(int, ilog.views.chart.IlvStyle), Constant Field Values
  - BOTTOM_WALL
```
public static final int BOTTOM_WALL
```
    Constant identifying the bottom wall of a Cartesian chart.
    
    See Also:
    
    setWallStyle(int, ilog.views.chart.IlvStyle), Constant Field Values
  - BACK_WALL
```
public static final int BACK_WALL
```
    Constant identifying the back wall of a Cartesian chart.
    
    See Also:
    
    setWallStyle(int, ilog.views.chart.IlvStyle), Constant Field Values
  - ORTHOGRAPHIC
```
public static final int ORTHOGRAPHIC
```
    Type constant for orthographic projection.
    
    See Also:
    
    setProjectionType(int), Constant Field Values
  - OBLIQUE
```
public static final int OBLIQUE
```
    Type constant for oblique projection.
    
    See Also:
    
    setProjectionType(int), Constant Field Values
- Method Detail
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener lst)
```
    Adds a listener to listen to the modification of all properties.
    
    Parameters:
    
    lst - The listener to add.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener lst)
```
    Adds a listener to listen to the modification of the specified property.
    
    Parameters:
    
    propertyName - The name of the property.
    
    lst - The listener to add.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener lst)
```
    Removes a listener so that it no longer listens to the modification of the properties.
    
    Parameters:
    
    lst - The listener to remove.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener lst)
```
    Removes a listener so that it no longer listens to the modification of the specified property.
    
    Parameters:
    
    propertyName - The name of the property.
    
    lst - The listener to remove.
  - getScene
```
public final ilog.views.chart.view3d.IlvChart3DScene getScene()
```
    Internal method.
  - getChart
```
public final IlvChart getChart()
```
    Returns the chart associated with the 3-D view.
  - draw
```
public void draw(Graphics g)
```
    Draws the contents of the 3-D view.
  - getFrontDepth
```
public double getFrontDepth()
```
    Returns the depth of the front plane (maximum z).
  - getBackDepth
```
public double getBackDepth()
```
    Returns the depth of the back plane (minimum z).
  - getZAnnotationRenderer
```
public final IlvLabelRenderer getZAnnotationRenderer()
```
    Returns the renderer used to display the text annotations along the depth axis.
  - setZAnnotationRenderer
```
public void setZAnnotationRenderer(IlvLabelRenderer renderer)
```
    Sets the renderer used to display the text annotations along the depth axis.
    Note: The color of the text annotation will be taken from the data set renderer if isZAnnotationColorVarying() is true.
    
    See Also:
    
    IlvSingleChartRenderer.getZAnnotationText()
  - isZAnnotationColorVarying
```
public final boolean isZAnnotationColorVarying()
```
    Returns true if the text annotations along the depth axis take the color of the corresponding data series.
    
    Since:
    
    JViews 7.5
  - setZAnnotationColorVarying
```
public void setZAnnotationColorVarying(boolean varying)
```
    Specifies whether the text annotations along the depth axis take the color of the corresponding data series, or whether they are all of the same color.
    
    Since:
    
    JViews 7.5
  - isZAnnotationVisible
```
public final boolean isZAnnotationVisible()
```
    Indicates whether text annotations are displayed along the depth axis.
    
    See Also:
    
    setZAnnotationRenderer(ilog.views.chart.IlvLabelRenderer)
  - setZAnnotationVisible
```
public void setZAnnotationVisible(boolean visible)
```
    Specifies whether text annotations are displayed along the depth axis.
    
    See Also:
    
    IlvSingleChartRenderer.getZAnnotationText(), setZAnnotationRenderer(ilog.views.chart.IlvLabelRenderer)
  - isZGridVisible
```
public final boolean isZGridVisible()
```
    Indicates whether z grid lines are drawn.
  - setZGridVisible
```
public void setZGridVisible(boolean visible)
```
    Specifies whether z grid lines are drawn.
  - getZGridStroke
```
public final Stroke getZGridStroke()
```
    Returns the stroke used to draw the grid lines along the depth axis.
  - setZGridStroke
```
public void setZGridStroke(Stroke stroke)
```
    Specifies the stroke used to draw the grid lines along the depth axis. If no stroke is specified, the stroke of the x-grid or the y-grid is used.
  - getZGridPaint
```
public final Paint getZGridPaint()
```
    Returns the paint used to draw the grid lines along the depth axis.
  - setZGridPaint
```
public void setZGridPaint(Paint paint)
```
    Specifies the paint used to draw the grid lines along the depth axis.
  - getLightLatitude
```
public final double getLightLatitude()
```
    Returns the light latitude.
    
    See Also:
    
    setLightLatitude(double)
  - setLightLatitude
```
public void setLightLatitude(double latitude)
```
    Sets the light latitude.
    The light location is specified using spherical coordinates in the projected space. It determines the direction of the light rays, which affects the color of a rendered surface.
    
    Parameters:
    
    latitude - The light latitude in degrees. The default value is 0 (the light is located at the eye).
    
    See Also:
    
    setLightLongitude(double)
  - getLightLongitude
```
public final double getLightLongitude()
```
    Returns the light longitude.
    
    See Also:
    
    setLightLongitude(double)
  - setLightLongitude
```
public void setLightLongitude(double longitude)
```
    Sets the light longitude.
    The light location is specified using spherical coordinates in the projected space. It determines the direction of the light rays, which affects the color of a rendered surface.
    
    Parameters:
    
    longitude - The light longitude in degrees. The default value is 0 (the light is located at the eye).
    
    See Also:
    
    setLightLatitude(double)
  - getAmbientLight
```
public final float getAmbientLight()
```
    Returns the intensity of the ambient light.
    
    See Also:
    
    setAmbientLight(float)
  - setAmbientLight
```
public void setAmbientLight(float intensity)
```
    Sets the intensity of the ambient light.
    This intensity defines the ambient lighting and affects the color of a rendered surface independently of its orientation.
    
    Parameters:
    
    intensity - The intensity, in the range [0 1]. A value of 0 means that the light is turned off. A value of 1 indicates a maximum intensity and produces a white shading for all surfaces.
    
    See Also:
    
    getAmbientLight()
  - getProjectionType
```
public final int getProjectionType()
```
    Returns the projection type.
    
    See Also:
    
    setProjectionType(int)
  - setProjectionType
```
public void setProjectionType(int projectionType)
```
    Sets the projection type.
    Note: The oblique projection preserves the orthogonality of the x- and y-axes. It can only be used with Cartesian charts.
    
    Parameters:
    
    projectionType - The new projection type.
    
    See Also:
    
    OBLIQUE, ORTHOGRAPHIC
  - getElevation
```
public final double getElevation()
```
    Returns the elevation angle.
    
    Returns:
    
    The elevation angle in degrees.
  - setElevation
```
public void setElevation(double angle)
```
    Sets the elevation angle.
    
    Parameters:
    
    angle - The elevation angle in degrees, within the range [-90 .. 90].
  - getRotation
```
public final double getRotation()
```
    Returns the rotation angle.
    
    Returns:
    
    The rotation angle in degrees.
  - setRotation
```
public void setRotation(double angle)
```
    Sets the rotation angle.
    
    Parameters:
    
    angle - The rotation angle in degrees. The angle must be within the range [-90 .. 90] for Cartesian charts. It can take any values for pie charts.
  - setViewAngles
```
public void setViewAngles(double rotation,
                          double elevation)
```
    Sets the view angles.
    
    Parameters:
    
    rotation - The rotation angle in degrees.
    
    elevation - The elevation angle in degrees.
    
    See Also:
    
    setRotation(double), setElevation(double)
  - getDepth
```
public final int getDepth()
```
    Returns the depth of the chart.
    
    See Also:
    
    setDepth(int)
  - setDepth
```
public void setDepth(int depth)
```
    Sets the depth of the chart relatively to its width. The default value is 20.
    
    Parameters:
    
    depth - A percentage of the width, between 1 and 100.
    
    See Also:
    
    getDepth()
  - getDepthGap
```
public final int getDepthGap()
```
    Returns the depth gap between two consecutive layers along the z-axis.
    
    See Also:
    
    setDepthGap(int)
  - setDepthGap
```
public void setDepthGap(int gap)
```
    Sets the depth gap between two consecutive renderers. The default value is 0.
    
    Parameters:
    
    gap - The gap, expressed as a percentage of the available depth.
    
    See Also:
    
    getDepthGap()
  - getZoom
```
public final double getZoom()
```
    Returns the zooming factor.
    
    See Also:
    
    setZoom(double)
  - setZoom
```
public void setZoom(double zoomFactor)
```
    Sets the zooming factor.
    
    Parameters:
    
    zoomFactor - The zooming factor, which is multiplied to the x- and y- scaling factors of the projection.
    
    See Also:
    
    getZoom()
  - isAutoScaling
```
public final boolean isAutoScaling()
```
    Indicates whether the automatic scaling of the view is active.
    
    See Also:
    
    setAutoScaling(boolean)
  - setAutoScaling
```
public void setAutoScaling(boolean auto)
```
    Toggles the automatic scaling of the view.
    
    Parameters:
    
    auto - If set to true, the view tries to compute the x- and y- scaling factors so that the drawing fits the rectangle of the chart area. Note that the computed scaling factors are then multiplied by the zoom factor specified by the setZoom(double) method. If set to false, no automatic scaling is applied.
  - setWallStyle
```
public void setWallStyle(int mask,
                         IlvStyle style)
```
    Sets the rendering styles for the walls of a 3-D Cartesian chart.
    
    Parameters:
    
    mask - An XOR combination of the constants that references the walls. For example, you can change the style of the left and right walls with the following code: view3D.setWallStyle(view3D.LEFT_WALL|view3D.RIGHT_WALL,style).
    
    style - The rendering style for the specified walls. If null, the style of the chart plotting area is used.
    
    See Also:
    
    LEFT_WALL, RIGHT_WALL, TOP_WALL, BOTTOM_WALL, BACK_WALL, IlvChart.Area.getPlotStyle()
  - toDisplay
```
public IlvDoublePoints toDisplay(IlvDoublePoints pts,
                                 int yAxis,
                                 double z)
```
    Projects the specified points.
    
    Parameters:
    
    pts - The considered points.
    
    yAxis - The index of the considered y-axis.
    
    z - The z-coordinate of the points.
  - getZLayers
```
public List<IlvChart3DView.ZLayer> getZLayers()
```
    Returns the depth layers.
    
    Returns:
    
    The depth layers. The returned list is an unmodifiable version of the internal layer list.
    
    See Also:
    
    IlvChart3DView.ZLayer

Class IlvChart3DView

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEFT_WALL

RIGHT_WALL

TOP_WALL

BOTTOM_WALL

BACK_WALL

ORTHOGRAPHIC

OBLIQUE

Method Detail

addPropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

removePropertyChangeListener

getScene

getChart

draw

getFrontDepth

getBackDepth

getZAnnotationRenderer

setZAnnotationRenderer

isZAnnotationColorVarying

setZAnnotationColorVarying

isZAnnotationVisible

setZAnnotationVisible

isZGridVisible

setZGridVisible

getZGridStroke

setZGridStroke

getZGridPaint

setZGridPaint

getLightLatitude

setLightLatitude

getLightLongitude

setLightLongitude

getAmbientLight

setAmbientLight

getProjectionType

setProjectionType

getElevation

setElevation

getRotation

setRotation

setViewAngles

getDepth

setDepth

getDepthGap

setDepthGap

getZoom

setZoom

isAutoScaling

setAutoScaling

setWallStyle

toDisplay

getZLayers