com.softwarefx.chartfx.server
Class Attributes3D

java.lang.Object
  com.softwarefx.chartfx.server.Attributes3D

public class Attributes3D
extends Object

Provides access to the Attributes3D object.

The Attributes3D class supported members allow developers to add 3D views and perspective to charts. By enabling 3D in charts, developers may further customize the display by manipulating X and Y angles, depth, perspective, rotation and shadowing. Additionally, members like Cluster allow you to add a Z dimension to charts.

Constructor Summary

Attributes3D()

Method Summary

int	getAngleX() Gets the AngleX.
int	getAngleY() Gets the AngleY.
int	getBoxThickness() Gets the BoxThickness.
int	getDepth() Gets the Depth.
int	getPerspective() Gets the Perspective.
Shadow	getShadow() Gets the Shadow.
boolean	isCluster() Gets the Cluster.
boolean	isEnabled() Gets the Enabled.
boolean	isRotated() Gets the Rotated.
void	setAngleX(int value) Sets the 3D rotation angle around the X-axis.
void	setAngleY(int value) Sets a 3D rotation angle around the Y-axis.
void	setBoxThickness(int value) Sets the thickness for the box surrounding the chart.
void	setCluster(boolean value) Displays a z-clustered 3D chart.
void	setDepth(int value) Sets the thickness along the Z-axis for the series.
void	setEnabled(boolean value) Sets a value indicating whether 3D effects should be applied.
void	setPerspective(int value) Allows you to set a 3D perspective to control the view of the chart depth.
void	setRotated(boolean value) Sets a value indicating the chart is Rotated.
void	setShadow(Shadow value) Sets a value indicating the type of shading to display when rotating the chart.

Methods inherited from class java.lang.Object

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

Constructor Detail

Attributes3D

public Attributes3D()

Method Detail

getAngleX

public int getAngleX()

Gets the AngleX. For more detail see setAngleX(int).

getAngleY

public int getAngleY()

Gets the AngleY. For more detail see setAngleY(int).

getBoxThickness

public int getBoxThickness()

Gets the BoxThickness. For more detail see setBoxThickness(int).

getDepth

public int getDepth()

Gets the Depth. For more detail see setDepth(int).

getPerspective

public int getPerspective()

Gets the Perspective. For more detail see setPerspective(int).

getShadow

public Shadow getShadow()

Gets the Shadow. For more detail see setShadow(com.softwarefx.chartfx.server.Shadow).

isCluster

public boolean isCluster()

Gets the Cluster. For more detail see setCluster(boolean).

isEnabled

public boolean isEnabled()

Gets the Enabled. For more detail see setEnabled(boolean).

isRotated

public boolean isRotated()

Gets the Rotated. For more detail see setRotated(boolean).

setAngleX

public void setAngleX(int value)

Sets the 3D rotation angle around the X-axis.

Remarks:

The value can be set to an integer between [0-90] or [270-360] indicating the degree of rotation around the X-axis.

Negative values or values greater than 360 are automatically reduced to a value in the range of 0 to 359.

This property can only be used when the chart is in 3D view. So, be sure the setEnabled(boolean) property is set to True.

To avoid jagged lines we recommend you use prominent angles (for example: 0,30,45,60,90, etc).

To set a Y-axis rotation angle, please refer to the setAngleY(int) property.

See Also:

setAngleY(int), Chart.getView3D(), Chart

setAngleY

public void setAngleY(int value)

Sets a 3D rotation angle around the Y-axis.

Remarks:

The value can be set to an integer between [0-90] or [270-360] indicating the degree of rotation around the Y-axis.

Negative values or values greater than 360 are automatically reduced to a value in the range of 0 to 359.

This property can only be used when the chart is in 3D view. So, be sure the setEnabled(boolean) property is set to True.

To avoid jagged lines we recommend you use prominent angles (for example: 0,30,45,60,90, etc).

To set an X-axis rotation angle, please refer to the setAngleX(int) property.

See Also:

setAngleX(int), Chart.getView3D()

setBoxThickness

public void setBoxThickness(int value)

Sets the thickness for the box surrounding the chart.

Remarks:

Here is a chart with a BoxThickness of 10.

See Also:

setAngleX(int), setAngleY(int), setDepth(int), setPerspective(int), Chart.getView3D(), Chart

setCluster

public void setCluster(boolean value)

Displays a z-clustered 3D chart.

When set to True, the chart will show as clustered; when set to False, the chart displays the series side-by-side.

Remarks:

When setting this property, you must make sure that the chart is displayed in 3D mode (by setting the setEnabled(boolean) property to true) and that the chart is cluster capable (BAR, LINES or GANTT chart).

When displaying a clustered chart, each series will have its own position in the Z axis. This means, if this property is set to true, then each data series will occupy one row of data along the Z-axis

AREA charts are always clustered as there is no way to paint different series side by side. On the other hand, if you have a BAR chart, it is possible to paint bars side-by-side and not clustered in the z-axis.

Below is an example of a non-clustered bar chart vs. a clustered bar chart.

Non-Clustered:

Clustered:

See Also:

Chart.getView3D(), Chart

setDepth

public void setDepth(int value)

Sets the thickness along the Z-axis for the series.

Remarks:

Here are two examples demonstrating the differences when using a Depth of 0 and a Depth of 150.

Depth value of 0:

Depth value of 150:

See Also:

setBoxThickness(int), Chart.getView3D(), Chart

setEnabled

public void setEnabled(boolean value)

Sets a value indicating whether 3D effects should be applied.

Remarks:

Toggles the chart between 2D and 3D modes. When set to True the chart is displayed in 3D.

See Also:

Chart.getView3D(), Chart

setPerspective

public void setPerspective(int value)

Allows you to set a 3D perspective to control the view of the chart depth.

Remarks:

The perspective value specifies the ratio of the front of the chart to the back of the chart. It ranges from 0 (default) degrees to 100 degrees.

In order to apply a perspective, the chart setEnabled(boolean) must be set to True.

To see the difference, below is a chart with the perspective set to 0 (the default) and the same chart set with a perspective of 50.

A perspective value of 0 (default):

A perspective value of 50:

See Also:

Chart.getView3D(), Chart

setRotated

public void setRotated(boolean value)

Sets a value indicating the chart is Rotated.

Remarks:

Allows you to enable or disable a Rotated view in a 3D chart.

When a chart is Rotated, angles and perspective attributes are also applied.

See Also:

setAngleX(int), setAngleY(int), setPerspective(int), Chart.getView3D(), Chart

setShadow

public void setShadow(Shadow value)

Sets a value indicating the type of shading to display when rotating the chart.

Remarks:

See Also:

Chart.getView3D(), Chart