NChartPlane Class Reference

Inherits from NChartObject : NSObject
Declared in NChartPlane.h

Overview

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.

+ plane

Create plane.

+ (NChartPlane *)plane

Return Value

new instance of the plane.

Declared In

NChartPlane.h

+ planeWithA:b:c:d:color:

Create plane with the equation coefficients and color.

+ (NChartPlane *)planeWithA:(double)a b:(double)b c:(double)c d:(double)d color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

+ planeParallelToYZWithX:color:

Create plane parallel to YZ coordinates plane with given X-coordinate. This is equivalent to set a = 1, b = 0, c = 0, d = -x

+ (NChartPlane *)planeParallelToYZWithX:(double)x color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

+ planeParallelToXZWithY:color:

Create plane parallel to XZ coordinates plane with given Y-coordinate. This is equivalent to set a = 0, b = 1, c = 0, d = -y

+ (NChartPlane *)planeParallelToXZWithY:(double)y color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

+ planeParallelToXYWithZ:color:

Create plane parallel to XY coordinates plane with given Z-coordinate. This is equivalent to set a = 0, b = 0, c = 1, d = -z

+ (NChartPlane *)planeParallelToXYWithZ:(double)z color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

– initWithA:b:c:d:color:

Init plane with the equation coefficients and color.

- (id)initWithA:(double)a b:(double)b c:(double)c d:(double)d color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

– initParallelToYZWithX:color:

Init plane parallel to YZ coordinates plane with given X-coordinate. This is equivalent to set a = 1, b = 0, c = 0, d = -x

- (id)initParallelToYZWithX:(double)x color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

– initParallelToXZWithY:color:

Init plane parallel to XZ coordinates plane with given Y-coordinate. This is equivalent to set a = 0, b = 1, c = 0, d = -y

- (id)initParallelToXZWithY:(double)y color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

– initParallelToXYWithZ:color:

Init plane parallel to XY coordinates plane with given Z-coordinate. This is equivalent to set a = 0, b = 0, c = 1, d = -z

- (id)initParallelToXYWithZ:(double)z color:(NSColor *)color

Parameters

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

Return Value

new instance of the plane.

Declared In

NChartPlane.h

  a

Plane equation coefficient a.

@property (nonatomic, assign) double a

Declared In

NChartPlane.h

  b

Plane equation coefficient b.

@property (nonatomic, assign) double b

Declared In

NChartPlane.h

  c

Plane equation coefficient c.

@property (nonatomic, assign) double c

Declared In

NChartPlane.h

  d

Plane equation coefficient d.

@property (nonatomic, assign) double d

Declared In

NChartPlane.h

– setA:b:c:d:

Set all equation coefficients at once.

- (void)setA:(double)a b:(double)b c:(double)c d:(double)d

Parameters

a
  • equation coefficient a.
b
  • equation coefficient b.
c
  • equation coefficient c.
d
  • equation coefficient d.

Declared In

NChartPlane.h

– setParallelToYZWithX:

Set the plane to be parallel to YZ.

- (void)setParallelToYZWithX:(double)x

Parameters

x
  • x-coorditane of the plane.

Declared In

NChartPlane.h

– setParallelToXZWithY:

Set the plane to be parallel to XZ.

- (void)setParallelToXZWithY:(double)y

Parameters

y
  • y-coorditane of the plane.

Declared In

NChartPlane.h

– setParallelToXYWithZ:

Set the plane to be parallel to XY.

- (void)setParallelToXYWithZ:(double)z

Parameters

z
  • z-coorditane of the plane.

Declared In

NChartPlane.h

  color

Plane color.

@property (nonatomic, strong) NSColor *color

Declared In

NChartPlane.h

  hostsOnSX

Flag that determines if the plane is hosted on the secondary X-axis. If YES, it will be drawn according to the secondary X-axis, if NO 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.

@property (nonatomic, assign) BOOL hostsOnSX

Declared In

NChartPlane.h

  hostsOnSY

Flag that determines if the plane is hosted on the secondary Y-axis. If YES, it will be drawn according to the secondary Y-axis, if NO 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.

@property (nonatomic, assign) BOOL hostsOnSY

Declared In

NChartPlane.h

  hostsOnSZ

Flag that determines if the plane is hosted on the secondary Z-axis. If YES, it will be drawn according to the secondary Z-axis, if NO 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.

@property (nonatomic, assign) BOOL hostsOnSZ

Declared In

NChartPlane.h