org.edisonwj.draw3d

Class Box3D

java.lang.Object

org.edisonwj.draw3d.Box3D

All Implemented Interfaces:

Draw3DDefaults

public class Box3D
extends java.lang.Object
implements Draw3DDefaults

Box3D class captures information defining a JavaFX Box instantiation with specified: - xyz location of center point (user coordinate scale) - width (user coordinate scale) - height (user coordinate scale) - depth (user coordinate scale) - xyz rotations (optional) - PhongMaterial (optional) - DrawMode setting (optional) - Cullface setting (optional) Box3D objects are drawn as javafx.scene.shape.box objects. The class implements defaults specified in Draw3DDefaults.

Version:

1.00 July 2015

Author:

William Edison

Field Summary

Fields inherited from interface org.edisonwj.draw3d.Draw3DDefaults

AMBIENT_LIGHT_ON, ARROW_POINT_HEIGHT, ARROW_POINT_RADIUS, ARROW_RADIUS, AV_POINT_DIVISIONS, AXIS_LENGTH, AXIS_RADIUS, BACKGROUND_COLOR, BOUNDRY_RADIUS, CAMERA_FAR_CLIP, CAMERA_INITIAL_DISTANCE, CAMERA_INITIAL_X_ANGLE, CAMERA_INITIAL_Y_ANGLE, CAMERA_NEAR_CLIP, CONE_DIVISIONS, CUMULATE_DEFAULT, CUMULATE_MANUAL_DEFAULT, CYLINDER_DIVISIONS, DEFAULT_ORIGIN, EDGE_RADIUS, EPSILON, LABEL_FONT, LABEL_FONT_SIZE, LINE_RADIUS, MIN_MAX_X, MIN_MAX_Y, MIN_MAX_Z, MOUSE_SPEED, OVAL_DIVISIONS, POINT_LIGHT_1_X, POINT_LIGHT_1_Y, POINT_LIGHT_1_Z, POINT_LIGHT_2_X, POINT_LIGHT_2_Y, POINT_LIGHT_2_Z, POINT_LIGHT_ON, POINT_SIZE, ROTATION_SPEED, SCENE_HEIGHT, SCENE_WIDTH, SCROLL_DELTA, SCROLL_FACTOR, SHOW_AXES, SHOW_BOUNDARY_CUBE, SHOW_DEFAULT_GRID, SHOW_TICK_MARKS, SHOW_X_Y_ONLY, SHOW_Z_AXIS_UP, SPHERE_DIVISIONS, TICK_MARK_LENGTH, TICK_MARK_RADIUS, VECTOR_POINT_HEIGHT, VECTOR_POINT_RADIUS, VECTOR_RADIUS, VERTEX_SIZE

Constructor Summary

Constructors

Constructor and Description
Box3D(double x, double y, double z, double width, double height, double depth) Constructs a Box3D object given its center point coordinates, width, height, and depth.
Box3D(double x, double y, double z, double width, double height, double depth, double xr, double yr, double zr) Constructs a Box3D object given its center point coordinates, width, height, depth, and x, y, z rotations.
Box3D(double x, double y, double z, double width, double height, double depth, double xr, double yr, double zr, javafx.scene.paint.PhongMaterial m) Constructs a Box3D object given its center point coordinates, width, height, depth, x, y, z rotations and PhongMaterial.
Box3D(double x, double y, double z, double width, double height, double depth, javafx.scene.paint.PhongMaterial m) Constructs a Box3D object given its center point coordinates, width, height, depth, and PhongMaterial.
Box3D(javafx.geometry.Point3D p, double width, double height, double depth) Constructs a Box3D object given its center point, width, height, and depth.
Box3D(javafx.geometry.Point3D p, double width, double height, double depth, double xr, double yr, double zr) Constructs a Box3D object given its center point, width, height, depth, and x, y, z rotations.
Box3D(javafx.geometry.Point3D p, double width, double height, double depth, double xr, double yr, double zr, javafx.scene.paint.PhongMaterial m) Constructs a Box3D object given its center point, width, height, depth, x, y, z rotations and PhongMaterial.
Box3D(javafx.geometry.Point3D p, double width, double height, double depth, javafx.scene.paint.PhongMaterial m) Constructs a Box3D object given its center point, width, height, depth, and PhongMaterial.
Box3D(java.lang.String lineString) Constructs a Box3D object given specification of the parameters in Save Data File format.

Method Summary

Modifier and Type	Method and Description
javafx.scene.shape.CullFace	getCullFace() Gets the Box CullFace property
double	getDepth() Gets the Box depth
javafx.scene.shape.DrawMode	getDrawMode() Gets the Box DrawMode property
Line3D[]	getEdges() Returns the set of edges with the box centered at the origin
double	getHeight() Gets the Box height
javafx.scene.paint.PhongMaterial	getMaterial() Gets the Box PhongMaterial property
javafx.geometry.Point3D	getP() Gets the Box location
double	getWidth() Gets the Box width
double	getXr() Gets the Box x axis rotation
double	getYr() Gets the Box y axis rotation
double	getZr() Gets the Box z axis rotation
java.lang.String	outString() Returns a String containing all Box3D values for saving to a data file.
void	setCullFace(javafx.scene.shape.CullFace cf) Sets the Box CullFace property
void	setDrawMode(javafx.scene.shape.DrawMode dm) Sets the Box DrawMode property
void	setMaterial(javafx.scene.paint.PhongMaterial m) Sets the Box PhongMaterial property
java.lang.String	toString() Returns a String for printing all Box3D values

Methods inherited from class java.lang.Object

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

Constructor Detail

Box3D

public Box3D(javafx.geometry.Point3D p,
             double width,
             double height,
             double depth)

Constructs a Box3D object given its center point, width, height, and depth.

Parameters:

p - Point3D center point of the box

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

Box3D

public Box3D(javafx.geometry.Point3D p,
             double width,
             double height,
             double depth,
             javafx.scene.paint.PhongMaterial m)

Constructs a Box3D object given its center point, width, height, depth, and PhongMaterial.

Parameters:

p - Point3D center point of the box

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

m - PhongMaterial determining box color

Box3D

public Box3D(javafx.geometry.Point3D p,
             double width,
             double height,
             double depth,
             double xr,
             double yr,
             double zr)

Constructs a Box3D object given its center point, width, height, depth, and x, y, z rotations.

Parameters:

p - Point3D center point of the box

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

xr - Rotation in degrees about the x axis

yr - Rotation in degrees about the y axis

zr - Rotation in degrees about the z axis

Box3D

public Box3D(javafx.geometry.Point3D p,
             double width,
             double height,
             double depth,
             double xr,
             double yr,
             double zr,
             javafx.scene.paint.PhongMaterial m)

Constructs a Box3D object given its center point, width, height, depth, x, y, z rotations and PhongMaterial.

Parameters:

p - Point3D center point of the box

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

xr - Rotation in degrees about the x axis

yr - Rotation in degrees about the y axis

zr - Rotation in degrees about the z axis

m - PhongMaterial determining box color

Box3D

public Box3D(double x,
             double y,
             double z,
             double width,
             double height,
             double depth)

Constructs a Box3D object given its center point coordinates, width, height, and depth.

Parameters:

x - Center point x coordinate in user coordinates

y - Center point y coordinate in user coordinates

z - Center point z coordinate in user coordinates

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

Box3D

public Box3D(double x,
             double y,
             double z,
             double width,
             double height,
             double depth,
             javafx.scene.paint.PhongMaterial m)

Constructs a Box3D object given its center point coordinates, width, height, depth, and PhongMaterial.

Parameters:

x - Center point x coordinate in user coordinates

y - Center point y coordinate in user coordinates

z - Center point z coordinate in user coordinates

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

m - PhongMaterial determining box color

Box3D

public Box3D(double x,
             double y,
             double z,
             double width,
             double height,
             double depth,
             double xr,
             double yr,
             double zr)

Constructs a Box3D object given its center point coordinates, width, height, depth, and x, y, z rotations.

Parameters:

x - Center point x coordinate in user coordinates

y - Center point y coordinate in user coordinates

z - Center point z coordinate in user coordinates

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

xr - Rotation in degrees about the x axis

yr - Rotation in degrees about the y axis

zr - Rotation in degrees about the z axis

Box3D

public Box3D(double x,
             double y,
             double z,
             double width,
             double height,
             double depth,
             double xr,
             double yr,
             double zr,
             javafx.scene.paint.PhongMaterial m)

Constructs a Box3D object given its center point coordinates, width, height, depth, x, y, z rotations and PhongMaterial.

Parameters:

x - Center point x coordinate in user coordinates

y - Center point y coordinate in user coordinates

z - Center point z coordinate in user coordinates

width - Width of the box in user coordinates

height - Height of the box in user coordinates

depth - Depth of the box in user coordinates

xr - Rotation in degrees about the x axis

yr - Rotation in degrees about the y axis

zr - Rotation in degrees about the z axis

m - PhongMaterial determining box color

Box3D

public Box3D(java.lang.String lineString)

Constructs a Box3D object given specification of the parameters in Save Data File format.

Parameters:

lineString - Box: format data string

Method Detail

getP

public javafx.geometry.Point3D getP()

Gets the Box location

Returns:

p Point3D location of the center point of the Box in user coordinates

getWidth

public double getWidth()

Gets the Box width

Returns:

width Double value of the width in user coordinate space

getHeight

public double getHeight()

Gets the Box height

Returns:

height Double value of the height in user coordinate space

getDepth

public double getDepth()

Gets the Box depth

Returns:

depth Double value of the depth in user coordinate space

getXr

public double getXr()

Gets the Box x axis rotation

Returns:

xr Double value of the Box x axis rotation

getYr

public double getYr()

Gets the Box y axis rotation

Returns:

yr Double value of the Box y axis rotation

getZr

public double getZr()

Gets the Box z axis rotation

Returns:

zr Double value of the Box z axis rotation

getEdges

public Line3D[] getEdges()

Returns the set of edges with the box centered at the origin

Returns:

edges Point3D[] array of edges of the box

getMaterial

public javafx.scene.paint.PhongMaterial getMaterial()

Gets the Box PhongMaterial property

Returns:

m PhongMaterial value of the Box

setMaterial

public void setMaterial(javafx.scene.paint.PhongMaterial m)

Sets the Box PhongMaterial property

Parameters:

m - PhongMaterial property of the Box

getDrawMode

public javafx.scene.shape.DrawMode getDrawMode()

Gets the Box DrawMode property

Returns:

dm DrawMode property of the Box

setDrawMode

public void setDrawMode(javafx.scene.shape.DrawMode dm)

Sets the Box DrawMode property

Parameters:

dm - DrawMode property of the Box

getCullFace

public javafx.scene.shape.CullFace getCullFace()

Gets the Box CullFace property

Returns:

cf CullFace property of the Box

setCullFace

public void setCullFace(javafx.scene.shape.CullFace cf)

Sets the Box CullFace property

Parameters:

cf - CullFace property of the Box

outString

public java.lang.String outString()

Returns a String containing all Box3D values for saving to a data file. The String is processed by the Box3D(String) constructor to recreate a Box3D object when reading a saved data file.

Returns:

String capturing all Box field values

toString

public java.lang.String toString()

Returns a String for printing all Box3D values

Overrides:

toString in class java.lang.Object

Returns:

String for printing all Box3D field values