oracle.dss.graph
Class ThreeDViewMatrix

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.ThreeDViewMatrix

public class ThreeDViewMatrix
extends BaseComponentXML

Allows you to adjust the 3-D properties of the graph.

Field Summary

protected PFJ

m_pfj

Fields inherited from class oracle.dss.dataView.BaseComponentXML

m_jsfHashMap

Constructor Summary

ThreeDViewMatrix(CommonGraph graph, PFJ pfj)

Method Summary

protected java.lang.String	getComponentName()
double	getFocusFactor() Retrieves the focus factor for this 3-D graph.
double	getLightSourceX() Retrieves the X-coordinate light source for the shading of walls and data markers in this 3-D graph.
double	getLightSourceY() Retrieves the Y-coordinate light source for the shading of walls and data markers in this 3-D graph.
double	getLightSourceZ() Retrieves the Z-coordinate light source for the shading of walls and data markers in this 3-D graph.
double	getPanX() Retrieves the pan value of the graph in the X direction.
double	getPanY() Retrieves the pan value of the graph in the Y direction.
double	getSizeX() Retrieves the size of the 3-D graph floor along the X edge, in virtual coordinates.
double	getSizeY() Retrieves the hight for the walls of the 3-D graph, in virtual coordinates.
double	getSizeZ() Retrieves the size of the 3-D graph floor along the Z edge, in virtual coordinates.
boolean	getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
double	getTranslationX() Retrieves the translation value of the graph in the X direction.
double	getTranslationY() Retrieves the translation value of the graph in the Y direction.
double	getTranslationZ() Retrieves the translation value of the graph in the Z direction.
double	getViewerX() Retrieves the value that represents the position of the viewer in the X direction, in relation to the position of the graph.
double	getViewerY() Retrieves the value that represents the position of the viewer in the Y direction, in relation to the position of the graph.
double	getViewerZ() Retrieves the value that represents the position of the viewer in the Z direction, in relation to the position of the graph.
double	getWallThickX() Retrieves the thickness of the wall on the X-axis of the graph.
double	getWallThickY() Retrieves the thickness of the wall on the Y-axis of the graph.
double	getWallThickZ() Retrieves the thickness of the wall on the Z-axis of the graph.
double	getZoomFactor() Retrieves the zoom factor of the graph.
boolean	isIsometricProjection() Indicates whether the 3-D components of the graph are displayed isometrically, without distortion.
boolean	isSquareRisers() Indicates whether the data markers in this graph are perfectly square.
protected void	resetStyle()
void	setFocusFactor(double newValue) Specifies the focus factor for this 3-D graph.
void	setIsometricProjection(boolean yesNo) Specifies whether the 3-D components of the graph are displayed isometrically, without distortion.
void	setLightSourceX(double newValue) Specifies the X-coordinate light source for the shading of walls and data markers in this 3-D graph.
void	setLightSourceY(double newValue) Specifies the Y-coordinate light source for the shading of walls and data markers in this 3-D graph.
void	setLightSourceZ(double newValue) Specifies the Z-coordinate light source for the shading of walls and data markers in this 3-D graph.
void	setPanX(double newValue) Specifies the pan value of the graph in the X direction.
void	setPanY(double newValue) Specifies the pan value of the graph in the Y direction.
void	setSizeX(double newValue) Specifies the size of the 3-D graph floor along the X edge, in virtual coordinates.
void	setSizeY(double newValue) Specifies the hight for the walls of the 3-D graph, in virtual coordinates.
void	setSizeZ(double newValue) Specifies the size of the 3-D graph floor along the Z edge, in virtual coordinates.
void	setSquareRisers(boolean yesNo) Specifies whether the data markers in this graph are perfectly square.
void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
void	setTranslationX(double newValue) Specifies the translation value of the graph in the X direction.
void	setTranslationY(double newValue) Specifies the translation value of the graph in the Y direction.
void	setTranslationZ(double newValue) Specifies the translation value of the graph in the Z direction.
void	setViewerX(double newValue) Specifies the value that represents the position of the viewer in the X direction, in relation to the position of the graph.
void	setViewerY(double newValue) Specifies the value that represents the position of the viewer in the Y direction, in relation to the position of the graph.
void	setViewerZ(double newValue) Specifies the value that represents the position of the viewer in the Z direction, in relation to the position of the graph.
void	setWallThickX(double newValue) Specifies the thickness of the wall on the X-axis of the graph.
void	setWallThickY(double newValue) Specifies the thickness of the wall on the X-axis of the graph.
void	setWallThickZ(double newValue) Specifies the thickness of the wall on the Z-axis of the graph.
void	setZoomFactor(double newValue) Specifies the zoom factor of the graph.

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getNonstyleXML, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

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

Field Detail

m_pfj

protected PFJ m_pfj

For internal use only. Application developers should not use this

Constructor Detail

ThreeDViewMatrix

public ThreeDViewMatrix(CommonGraph graph,
                        PFJ pfj)

Parameters:

graph - The graph object in which this matrix belongs

pfj - The PFJ object of the graph that this object belongs to. PFJ is an acronym for Perspective for Java. Perspective for Java is a third party package of objects that are used and manipulated by the BI Beans.

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph does it automatically.

Method Detail

getFocusFactor

public double getFocusFactor()

Retrieves the focus factor for this 3-D graph. The focus factor indicates the amount of distortion in the display of the 3-D components of the graph when you zoom in and zoom out of the graph. The values range from 0.0 to 100.0. The default value is 50.0. To make the graph use the return value of this method, set the setIsometricProjection method to false

Returns:

A value that represents the focus factor for this graph.

setFocusFactor

public void setFocusFactor(double newValue)

Specifies the focus factor for this 3-D graph. The focus factor indicates the amount of distortion in the display of the 3-D components of the graph when you zoom in and zoom out of the graph. The values range from 0.0 to 100.0. The default value is 50.0. To make the graph use the parameter value of this method, set the setIsometricProjection method to false

Parameters:

newValue - A value that represents the focus factor for this graph.

isIsometricProjection

public boolean isIsometricProjection()

Indicates whether the 3-D components of the graph are displayed isometrically, without distortion. When the graph displays the 3-D components isometrically, opposite sides of a 3-D component cube are parallel.

Returns:

true if they are displayed isometrically, false if they are displayed with distortion.

setIsometricProjection

public void setIsometricProjection(boolean yesNo)

Specifies whether the 3-D components of the graph are displayed isometrically, without distortion. When the graph displays the 3-D components isometrically, opposite sides of a 3-D component cube are parallel.

Parameters:

yesNo - true to display them isometrically, false to display them with distortion.

getLightSourceX

public double getLightSourceX()

Retrieves the X-coordinate light source for the shading of walls and data markers in this 3-D graph. The X-coordinate light source represents the direction from which a light source is projected onto the graph. The values for the light source indicate the amount of shadow that is created. Values range from 0.0 to 100.0. The default value is 0.0.

Returns:

A value that represents the X-coordinate light source for the shading of walls and data markers in this 3-D graph.

setLightSourceX

public void setLightSourceX(double newValue)

Specifies the X-coordinate light source for the shading of walls and data markers in this 3-D graph. The X-coordinate light source represents the direction from which a light source is projected onto the graph. The values for the light source indicate the amount of shadow that is created. Values range from 0.0 to 100.0. The default value is 0.0.

Parameters:

newValue - A value that represents the X-coordinate light source for the shading of walls and data markers in this 3-D graph.

getLightSourceY

public double getLightSourceY()

Retrieves the Y-coordinate light source for the shading of walls and data markers in this 3-D graph. The Y-coordinate light source represents the direction from which a light source is projected onto the graph. The values for the light source indicate the amount of shadow that is created. Values range from 0.0 to 100.0. The default value is 40.0.

Returns:

A value that represents the Y-coordinate light source for the shading of walls and data markers in this 3-D graph.

setLightSourceY

public void setLightSourceY(double newValue)

Specifies the Y-coordinate light source for the shading of walls and data markers in this 3-D graph. The Y-coordinate light source represents the direction from which a light source is projected onto the graph. The values for the light source indicate the amount of shadow that is created. Values range from 0.0 to 100.0. The default value is 40.0.

Parameters:

newValue - A value that represents the Y-coordinate light source for the shading of walls and data markers in this 3-D graph.

getLightSourceZ

public double getLightSourceZ()

Retrieves the Z-coordinate light source for the shading of walls and data markers in this 3-D graph. The Z-coordinate light source represents the direction from which a light source is projected onto the graph. The values for the light source indicate the amount of shadow that is created. Values range from 0.0 to 100.0. The default value is 100.0.

Returns:

A value that represents the Z-coordinate light source for the shading of walls and data markers in this 3-D graph.

setLightSourceZ

public void setLightSourceZ(double newValue)

Specifies the Z-coordinate light source for the shading of walls and data markers in this 3-D graph. The Z-coordinate light source represents the direction from which a light source is projected onto the graph. The values for the light source indicate the amount of shadow that is created. Values range from 0.0 to 100.0. The default value is 100.0.

Parameters:

newValue - A value that represents the Z-coordinate light source for the shading of walls and data markers in this 3-D graph.

getPanX

public double getPanX()

Retrieves the pan value of the graph in the X direction. The pan value indicates the X position of the graph within its frame. You use pan to move the graph in an axis direction without changing the perspective. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the X direction. Values range from 0.0 to 100.0. The default value is 39.3.

Returns:

The pan value of the graph in the X direction.

setPanX

public void setPanX(double newValue)

Specifies the pan value of the graph in the X direction. The pan value indicates the X position of the graph within its frame. You use pan to move the graph in an axis direction without changing the perspective. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the X direction. Values range from 0.0 to 100.0. The default value is 39.3.

Parameters:

newValue - The pan value of the graph in the X direction.

getPanY

public double getPanY()

Retrieves the pan value of the graph in the Y direction. The pan value indicates the Y position of the graph within its frame. You use pan to move the graph in an axis direction without changing the perspective. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Y direction. Values range from 0.0 to 100.0. The default value is 60.7.

Returns:

The pan value of the graph in the Y direction.

setPanY

public void setPanY(double newValue)

Specifies the pan value of the graph in the Y direction. The pan value indicates the Y position of the graph within its frame. You use pan to move the graph in an axis direction without changing the perspective. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Y direction. Values range from 0.0 to 100.0. The default value is 60.7.

Parameters:

newValue - The pan value of the graph in the Y direction.

getSizeX

public double getSizeX()

Retrieves the size of the 3-D graph floor along the X edge, in virtual coordinates. The values range from 0.0 to 100.0. The default value is 30.0.

Returns:

The size of the 3-D graph floor along the X edge, in virtual coordinates.

setSizeX

public void setSizeX(double newValue)

Specifies the size of the 3-D graph floor along the X edge, in virtual coordinates. The values range from 0.0 to 100.0. The default value is 30.0.

Parameters:

newValue - The size of the 3-D graph floor along the X edge, in virtual coordinates.

getSizeY

public double getSizeY()

Retrieves the hight for the walls of the 3-D graph, in virtual coordinates. The values range from 0.0 to 100.0. The default value is 25.0.

Returns:

The hight for the walls of the 3-D graph, in virtual coordinates.

setSizeY

public void setSizeY(double newValue)

Specifies the hight for the walls of the 3-D graph, in virtual coordinates. The values range from 0.0 to 100.0. The default value is 25.0.

Parameters:

newValue - The hight for the walls of the 3-D graph, in virtual coordinates.

getSizeZ

public double getSizeZ()

Retrieves the size of the 3-D graph floor along the Z edge, in virtual coordinates. The values range from 0.0 to 100.0. The default value is 30.0.

Returns:

The size of the 3-D graph floor along the Z edge, in virtual coordinates.

setSizeZ

public void setSizeZ(double newValue)

Specifies the size of the 3-D graph floor along the Z edge, in virtual coordinates. The values range from 0.0 to 100.0. The default value is 30.0.

Parameters:

newValue - The size of the 3-D graph floor along the Z edge, in virtual coordinates.

isSquareRisers

public boolean isSquareRisers()

Indicates whether the data markers in this graph are perfectly square. To oblongate the data markers, adjust the value in the setRiserThickness method.

Returns:

true if the data markers are perfectly square, false if the data markers are the width that is set in the setRiserThickness method.

setSquareRisers

public void setSquareRisers(boolean yesNo)

Specifies whether the data markers in this graph are perfectly square. To oblongate the data markers, adjust the value in the setRiserThickness method.

Parameters:

yesNo - true to make the data markers perfectly square, false to make the data markers the width that is set in the setRiserThickness method.

getTranslationX

public double getTranslationX()

Retrieves the translation value of the graph in the X direction. The translation value indicates the X position of the graph within its frame. Translation moves the graph in an axis direction while changing the perspective so that the dimensions and position of the graph are altered. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the X direction. Values range from 0.0 to 100.0. The default value is 65.0.

Returns:

The translation value of the graph in the X direction.

setTranslationX

public void setTranslationX(double newValue)

Specifies the translation value of the graph in the X direction. The translation value indicates the X position of the graph within its frame. Translation moves the graph in an axis direction while changing the perspective so that the dimensions and position of the graph are altered. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the X direction. Values range from 0.0 to 100.0. The default value is 65.0.

Parameters:

newValue - The translation value of the graph in the X direction.

getTranslationY

public double getTranslationY()

Retrieves the translation value of the graph in the Y direction. The translation value indicates the Y position of the graph within its frame. Translation moves the graph in an axis direction while changing the perspective so that the dimensions and position of the graph are altered. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Y direction. Values range from 0.0 to 100.0. The default value is 42.5.

Returns:

The translation value of the graph in the Y direction.

setTranslationY

public void setTranslationY(double newValue)

Specifies the translation value of the graph in the Y direction. The translation value indicates the Y position of the graph within its frame. Translation moves the graph in an axis direction while changing the perspective so that the dimensions and position of the graph are altered. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Y direction. Values range from 0.0 to 100.0. The default value is 42.5.

Parameters:

newValue - The translation value of the graph in the Y direction.

getTranslationZ

public double getTranslationZ()

Retrieves the translation value of the graph in the Z direction. The translation value indicates the Z position of the graph within its frame. Translation moves the graph in an axis direction while changing the perspective so that the dimensions and position of the graph are altered. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Z direction. Values range from 0.0 to 100.0. The default value is 50.0.

Returns:

The translation value of the graph in the Z direction.

setTranslationZ

public void setTranslationZ(double newValue)

Specifies the translation value of the graph in the Z direction. The translation value indicates the Z position of the graph within its frame. Translation moves the graph in an axis direction while changing the perspective so that the dimensions and position of the graph are altered. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Z direction. Values range from 0.0 to 100.0. The default value is 50.0.

Parameters:

newValue - The translation value of the graph in the Z direction.

getViewerX

public double getViewerX()

Retrieves the value that represents the position of the viewer in the X direction, in relation to the position of the graph. You are the viewer. The ViewerX property moves the graph within its frame and displays it with perspective, as though you are viewing the graph from an opposite X position. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the X direction. Values range from 0.0 to 100.0. The default value is 50.0.

Returns:

The value that represents the position of the viewer in the X direction, in relation to the position of the graph.

setViewerX

public void setViewerX(double newValue)

Specifies the value that represents the position of the viewer in the X direction, in relation to the position of the graph. You are the viewer. The ViewerX property moves the graph within its frame and displays it with perspective, as though you are viewing the graph from an opposite X position. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the X direction. Values range from 0.0 to 100.0. The default value is 50.0.

Parameters:

newValue - The value that represents the position of the viewer in the X direction, in relation to the position of the graph.

getViewerY

public double getViewerY()

Retrieves the value that represents the position of the viewer in the Y direction, in relation to the position of the graph. You are the viewer. The ViewerY property moves the graph within its frame and displays it with perspective, as though you are viewing the graph from an opposite Y position. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Y direction. Values range from 0.0 to 100.0. The default value is 60.0.

Returns:

The value that represents the position of the viewer in the Y direction, in relation to the position of the graph.

setViewerY

public void setViewerY(double newValue)

Specifies the value that represents the position of the viewer in the Y direction, in relation to the position of the graph. You are the viewer. The ViewerY property moves the graph within its frame and displays it with perspective, as though you are viewing the graph from an opposite Y position. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Y direction. Values range from 0.0 to 100.0. The default value is 60.0.

Parameters:

newValue - The value that represents the position of the viewer in the Y direction, in relation to the position of the graph.

getViewerZ

public double getViewerZ()

Retrieves the value that represents the position of the viewer in the Z direction, in relation to the position of the graph. You are the viewer. The ViewerZ property moves the graph within its frame and displays it with perspective, as though you are viewing the graph from an opposite Z position. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Z direction. Values range from 0.0 to 100.0. The default value is 36.8.

Returns:

The value that represents the position of the viewer in the Z direction, in relation to the position of the graph.

setViewerZ

public void setViewerZ(double newValue)

Specifies the value that represents the position of the viewer in the Z direction, in relation to the position of the graph. You are the viewer. The ViewerZ property moves the graph within its frame and displays it with perspective, as though you are viewing the graph from an opposite Z position. Perspective refers to the amount of distortion in the display of the 3-D objects of the graph. The default value centers the graph in the Z direction. Values range from 0.0 to 100.0. The default value is 36.8.

Parameters:

newValue - The value that represents the position of the viewer in the Z direction, in relation to the position of the graph.

getWallThickX

public double getWallThickX()

Retrieves the thickness of the wall on the X-axis of the graph. Values range from 0.0 to 100.0. The default value is 20.0.

Returns:

A value that represents the thickness of the wall on the X-axis of the graph.

setWallThickX

public void setWallThickX(double newValue)

Specifies the thickness of the wall on the X-axis of the graph. Values range from 0.0 to 100.0. The default value is 20.0.

Parameters:

newValue - A value that represents the thickness of the wall on the X-axis of the graph.

getWallThickY

public double getWallThickY()

Retrieves the thickness of the wall on the Y-axis of the graph. Values range from 0.0 to 100.0. The default value is 20.0.

Returns:

A value that represents the thickness of the wall on the Y-axis of the graph.

setWallThickY

public void setWallThickY(double newValue)

Specifies the thickness of the wall on the X-axis of the graph. Values range from 0.0 to 100.0. The default value is 20.0.

Parameters:

newValue - A value that represents the thickness of the wall on the X-axis of the graph.

getWallThickZ

public double getWallThickZ()

Retrieves the thickness of the wall on the Z-axis of the graph. Values range from 0.0 to 100.0. The default value is 20.0.

Returns:

A value that represents the thickness of the wall on the Z-axis of the graph.

setWallThickZ

public void setWallThickZ(double newValue)

Specifies the thickness of the wall on the Z-axis of the graph. Values range from 0.0 to 100.0. The default value is 20.0.

Parameters:

newValue - A value that represents the thickness of the wall on the Z-axis of the graph.

getZoomFactor

public double getZoomFactor()

Retrieves the zoom factor of the graph. The values range from 0.0 to 100.0. The default value is 50.0. A value greater than 1 indicates that the graph is zoomed in.

Returns:

A value that represents the zoom factor of the graph.

setZoomFactor

public void setZoomFactor(double newValue)

Specifies the zoom factor of the graph. The values range from 0.0 to 100.0. The default value is 50.0. To zoom in, set a value greater than 1.

Parameters:

newValue - A value that represents the zoom factor of the graph.

getComponentName

protected java.lang.String getComponentName()

Overrides:

getComponentName in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves the name of the component

getStyleXML

public boolean getStyleXML(boolean allProperties,
                           oracle.dss.util.xml.ObjectNode node)

Overrides:

getStyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves style properties of this component to XML returns whether if the style is overridden

setStyleXML

public void setStyleXML(oracle.dss.util.xml.ObjectNode node)

Overrides:

setStyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Sets style properties of this component from XML

resetStyle

protected void resetStyle()

For internal use only. Application developers should not use this

reset style properties