The NChartPlane class provides methods to display control planes which can be added to the chart's coordinate system to visually segment the space into subspaces. More...

Inheritance diagram for com.nchart3d.NChart.NChartPlane:

Public Member Functions
	NChartPlane ()
	Create plane.

	NChartPlane (double a, double b, double c, double d, int color)
	Init plane with the equation coefficients and color. More...

double	getA ()
	Plane equation coefficient a.

void	setA (double a)
	For details see getA().

double	getB ()
	Plane equation coefficient b.

void	setB (double b)
	For details see getB().

double	getC ()
	Plane equation coefficient c.

void	setC (double c)
	For details see getC().

double	getD ()
	Plane equation coefficient d.

void	setD (double d)
	For details see getD().

void	setABCD (double a, double b, double c, double d)
	Set all equation coefficients at once. More...

void	setParallelToYZWithX (double x)
	Set the plane to be parallel to YZ. More...

void	setParallelToXZWithY (double y)
	Set the plane to be parallel to XZ. More...

void	setParallelToXYWithZ (double z)
	Set the plane to be parallel to XY. More...

int	getColor ()
	Plane color.

void	setColor (int color)
	For details see getColor().

boolean	isHostsOnSX ()
	Flag that determines if the plane is hosted on the secondary X-axis. More...

void	setHostsOnSX (boolean hostsOnSX)
	For details see isHostsOnSX().

boolean	isHostsOnSY ()
	Flag that determines if the plane is hosted on the secondary Y-axis. More...

void	setHostsOnSY (boolean hostsOnSY)
	For details see isHostsOnSY().

boolean	isHostsOnSZ ()
	Flag that determines if the plane is hosted on the secondary Z-axis. More...

void	setHostsOnSZ (boolean hostsOnSZ)
	For details see isHostsOnSZ().

Public Member Functions inherited from com.nchart3d.NChart.NChartObject
boolean	isVisible ()
	Flag that determines if the object is visible or not. More...

void	setVisible (boolean visible)
	For details see isVisible().

NChart	getChart ()
	Chart the object belongs to. More...

Static Public Member Functions
static NChartPlane	plane ()
	Create plane. More...

static NChartPlane	planeWithA (double a, double b, double c, double d, int color)
	Create plane with the equation coefficients and color. More...

static NChartPlane	planeParallelToYZ (double x, int color)
	Create plane parallel to YZ coordinates plane with given X-coordinate. More...

static NChartPlane	planeParallelToXZ (double y, int color)
	Create plane parallel to XZ coordinates plane with given Y-coordinate. More...

static NChartPlane	planeParallelToXY (double z, int color)
	Create plane parallel to XY coordinates plane with given Z-coordinate. More...

Detailed Description

The NChartPlane class provides methods to display control planes which can be added to the chart's coordinate system to visually segment the space into subspaces.

Planes are defined by an equation a * x + b * y + c * z + d = 0 where the coefficients a, b, c, and d should be provided by the user.

Constructor & Destructor Documentation

com.nchart3d.NChart.NChartPlane.NChartPlane	(	double	a,
		double	b,
		double	c,
		double	d,
		int	color
	)

inline

Init plane with the equation coefficients and color.

Parameters

a	- equation coefficient a.
b	- equation coefficient b.
c	- equation coefficient c.
d	- equation coefficient d.
color	- color of the plane.

Member Function Documentation

boolean com.nchart3d.NChart.NChartPlane.isHostsOnSX ( )

inline

Flag that determines if the plane is hosted on the secondary X-axis.

If true, it will be drawn according to the secondary X-axis, if false according to the normal X-axis. The secondary axis appears opposite the normal axis and is managed separately: it can have its own min and max; its own color settings and so on.

boolean com.nchart3d.NChart.NChartPlane.isHostsOnSY ( )

inline

Flag that determines if the plane is hosted on the secondary Y-axis.

If true, it will be drawn according to the secondary Y-axis, if false according to the normal Y-axis. The secondary axis appears opposite the normal axis and is managed separately: it can have its own min and max; its own color settings and so on.

boolean com.nchart3d.NChart.NChartPlane.isHostsOnSZ ( )

inline

Flag that determines if the plane is hosted on the secondary Z-axis.

If true, it will be drawn according to the secondary Z-axis, if false according to the normal Z-axis. The secondary axis appears opposite the normal axis and is managed separately: can have its own min and max; its own color settings and so on.

static NChartPlane com.nchart3d.NChart.NChartPlane.plane ( )

inlinestatic

Create plane.

Returns: new instance of the plane.

static NChartPlane com.nchart3d.NChart.NChartPlane.planeParallelToXY	(	double	z,
		int	color
	)

inlinestatic

Create plane parallel to XY coordinates plane with given Z-coordinate.

This is equivalent to set a = 0, b = 0, c = 1, d = -z

Parameters

z	- z-coordinate of the plane.
color	- color of the plane.

Returns: new instance of the plane.

static NChartPlane com.nchart3d.NChart.NChartPlane.planeParallelToXZ	(	double	y,
		int	color
	)

inlinestatic

Create plane parallel to XZ coordinates plane with given Y-coordinate.

This is equivalent to set a = 0, b = 1, c = 0, d = -y

Parameters

y	- y-coordinate of the plane.
color	- color of the plane.

Returns: new instance of the plane.

static NChartPlane com.nchart3d.NChart.NChartPlane.planeParallelToYZ	(	double	x,
		int	color
	)

inlinestatic

Create plane parallel to YZ coordinates plane with given X-coordinate.

This is equivalent to set a = 1, b = 0, c = 0, d = -x

Parameters

x	- x-coordinate of the plane.
color	- color of the plane.

Returns: new instance of the plane.

static NChartPlane com.nchart3d.NChart.NChartPlane.planeWithA	(	double	a,
		double	b,
		double	c,
		double	d,
		int	color
	)

inlinestatic

Create plane with the equation coefficients and color.

Parameters

a	- equation coefficient a.
b	- equation coefficient b.
c	- equation coefficient c.
d	- equation coefficient d.
color	- color of the plane.

Returns: new instance of the plane.

void com.nchart3d.NChart.NChartPlane.setABCD	(	double	a,
		double	b,
		double	c,
		double	d
	)

inline

Set all equation coefficients at once.

Parameters

a	- equation coefficient a.
b	- equation coefficient b.
c	- equation coefficient c.
d	- equation coefficient d.

void com.nchart3d.NChart.NChartPlane.setParallelToXYWithZ ( double z )

inline

Set the plane to be parallel to XY.

Parameters

z	- z-coordinate of the plane.

void com.nchart3d.NChart.NChartPlane.setParallelToXZWithY ( double y )

inline

Set the plane to be parallel to XZ.

Parameters

y	- y-coordinate of the plane.

void com.nchart3d.NChart.NChartPlane.setParallelToYZWithX ( double x )

inline

Set the plane to be parallel to YZ.

Parameters

x	- x-coordinate of the plane.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation