Inheritance diagram for shapes3d.path.Spiral:

Public Member Functions
	Spiral (float radius, float nbr_twirls, float twirl_pitch, int nbrSlices)

	Spiral (float radiusX, float radiusZ, float nbr_twirls, float twirl_pitch, int nbrSlices)

PVector	point (float t)

PVector	tangent (float t)

PVector	orthogonal (float t)

Public Member Functions inherited from shapes3d.path.AbstractPath
int	nbrSlices ()

PVector	tangent (float t)

PVector	orthogonal (float t)

boolean	isOpenPath ()

Protected Member Functions
	Spiral ()

Protected Member Functions inherited from shapes3d.path.AbstractPath
	AbstractPath ()

	AbstractPath (int nbrSlices)

Protected Attributes
float	nbrTwirls = 1

float	twirlPitch = 10

float	radX

float	startY

float	spiralAngle

float	spiralPitch

Protected Attributes inherited from shapes3d.path.AbstractPath
final int	DEFAULT_NBR_SLICES = 100

final int	nbrSlices

boolean	pathIsOpen = true

Additional Inherited Members
Public Attributes inherited from shapes3d.path.AbstractPath
PathOrthogonal	orthoCalculator = null

Public Attributes inherited from shapes3d.utils.SConstants
int	WIRE = 0x00000011

int	SOLID = 0x00000012

int	TEXTURE = 0x00000014

int	DRAWALL = WIRE \| SOLID \| TEXTURE

int	WHITE = 0xFFFFFFFF

int	BLACK = 0xFF000000

int	GREY = 0xFFC0C0C0

int	RED = 0xFFFF0000

int	GREEN = 0xFF00FF00

int	BLUE = 0xFF0000FF

int	YELLOW = 0xFFFFFF00

int	PURPLE = 0xFFFF00FF

int	CYAN = 0xFF00FFFF

int	ORANGE = 0xFFFFC000

int	CW = 1

int	CCW = 2

int	ALL = 0b11111111

int	BOTTOM = 0b00000001

int	TOP = 0b00000010

int	FRONT = 0b00000100

int	BACK = 0b00001000

int	LEFT = 0b00010000

int	RIGHT = 0b00100000

int	BODY = 0b00000001

int	END0 = 0b00000010

int	END1 = 0b00000100

float	ONE_DEG_T = (float) (Math.PI / 180.0)

PathOrthogonal	ORTHO_X = new PathOrthogonal.PathNormalX()

PathOrthogonal	ORTHO_Y = new PathOrthogonal.PathNormalY()

PathOrthogonal	ORTHO_Z = new PathOrthogonal.PathNormalZ()

PathOrthogonal	ORTHO_A = new PathOrthogonal.PathNormalAMC()

TransformUV	ROT_0 = TransformUV.ROT0

TransformUV	ROT_90 = TransformUV.ROT90

TransformUV	ROT_180 = TransformUV.ROT180

TransformUV	ROT_270 = TransformUV.ROT270

TransformUV	FLIP_H = TransformUV.FLIPH

TransformUV	FLIP_V = TransformUV.FLIPV

Rotation	ROTATION_ZERO = new Rotation()

int	T_BOX = 0x1001

int	T_DOME = 0x1002

int	T_CONE = 0x1003

int	T_ELLIPSOID = 0x1004

int	T_EXTRUSION = 0x1005

int	T_LATHESTOCK = 0x1006

int	T_MD2 = 0x1007

int	T_SKYBOX = 0x1008

int	T_SKYDOME = 0x1009

int	T_TERRAIN = 0x100A

int	T_TUBE = 0x100B

int	C_LATHESURFACE = 0x2001

int	C_OVAL = 0x2002

int	C_POLYGON = 0x2003

int	P_BCURVE2D = 0x3001

int	P_BCURVE3D = 0x3002

int	P_BSPLINE2D = 0x3003

int	P_BSPLINE3D = 0x3004

int	P_LINEAR = 0x3005

int	P_LISSAJOUS = 0x3006

int	P_RING = 0x3007

int	P_SPIRAL = 0x3008

Detailed Description

This class represents a spiral or helical path. The spiral can be of any length and the path can be either circular or elliptical.

Author: Peter Lager

Constructor & Destructor Documentation

shapes3d.path.Spiral.Spiral ( )

protected

Hide default constructor

shapes3d.path.Spiral.Spiral	(	float	radius,
		float	nbr_twirls,
		float	twirl_pitch,
		int	nbrSlices
	)

Create an circular path

Parameters

radius	the spiral radius
nbr_twirls	number times the path does a full 360°
twirl_pitch	the distance between adjacent twirls.
nbrSlices	the number of slices along spiral length

shapes3d.path.Spiral.Spiral	(	float	radiusX,
		float	radiusZ,
		float	nbr_twirls,
		float	twirl_pitch,
		int	nbrSlices
	)

Create an elliptical path

Parameters

radiusX	the spiral radius in X direction
radiusZ	the spiral radius in Z direction
nbr_twirls	number times the path does a full 360°
twirl_pitch	the distance between adjacent twirls.
nbrSlices	the number of slices along spiral length

Member Function Documentation

PVector shapes3d.path.Spiral.orthogonal ( float t )

Get the orthogonal for any point along the spiral's length

Returns: the orthogonal vector

Implements shapes3d.path.Path.

PVector shapes3d.path.Spiral.point ( float t )

virtual

Get the position along the path.

Parameters

t	parametric value ≥0.0 and ≤1.0

Returns: a PVector giving the x,y,z coordinates at a position t

Implements shapes3d.path.AbstractPath.

PVector shapes3d.path.Spiral.tangent ( float t )

Get the normalised tangent to the path.

Parameters

t	parametric value ≥0.0 and ≤1.0

Returns: a PVector giving the x,y,z coordinates of the tangent at position t

Implements shapes3d.path.Path.

The documentation for this class was generated from the following file:

/Users/peter/git/shapes3d-repos/Shapes 3D/src/shapes3d/path/Spiral.java

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation