APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.scene.shape

public non-sealed Class Box

extends Shape3D
Class Inheritance
Imports
com.sun.javafx.geom.BaseBounds, .PickRay, .Vec3d, com.sun.javafx.geom.transform.BaseTransform, com.sun.javafx.scene.DirtyBits, .NodeHelper, com.sun.javafx.scene.input.PickResultChooser, com.sun.javafx.scene.shape.BoxHelper, com.sun.javafx.sg.prism.NGBox, .NGNode, javafx.beans.property.DoubleProperty, .SimpleDoubleProperty, javafx.geometry.Point2D, .Point3D, javafx.scene.Node, javafx.scene.input.PickResult

The Box class defines a 3 dimensional box with the specified size. A Box is a 3D geometry primitive created with a given depth, width, and height. It is centered at the origin.
Since
JavaFX 8.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
public static final double
DEFAULT_SIZE

Deprecated for removal since 18. This field was exposed mistakenly and will be removed.
Default size of the Box.
private DoubleProperty
depth

Defines the depth or the Z dimension of the Box.

private DoubleProperty
height

Defines the height or the Y dimension of the Box.

private TriangleMesh
private DoubleProperty
width

Defines the width or the X dimension of the Box.

Inherited from javafx.scene.shape.Shape3D:
keymanager

Constructor Summary

AccessConstructor and Description
public
Box()

Creates a new instance of Box of dimension 2 by 2 by 2.

public
Box(double
the width of this box
width
,
double
the height of this box
height
,
double
the depth of this box
depth
)

Creates a new instance of Box of dimension width by height by depth.

Method Summary

Modifier and TypeMethod and Description
pack-priv static TriangleMesh
createMesh(float w, float h, float d)

public final DoubleProperty
private boolean
private BaseBounds
private boolean
private NGNode
private void
public final double
public final double
public final double
public final DoubleProperty
public final void
setDepth(double value)

public final void
setHeight(double value)

public final void
setWidth(double value)

public final DoubleProperty
Inherited from javafx.scene.shape.Shape3D:
cullFacePropertydrawModePropertygetCullFacegetDrawModegetMaterialmaterialPropertysetCullFacesetDrawModesetMaterial

Field Detail

DEFAULT_SIZEback to summary
public static final double DEFAULT_SIZE

Deprecated

for removal since 18.

This field was exposed mistakenly and will be removed.

Default size of the Box.

Annotations
@Deprecated
since:18
forRemoval:true
depthback to summary
private DoubleProperty depth

Defines the depth or the Z dimension of the Box.

Default Value
2.0
heightback to summary
private DoubleProperty height

Defines the height or the Y dimension of the Box.

Default Value
2.0
meshback to summary
private TriangleMesh mesh
widthback to summary
private DoubleProperty width

Defines the width or the X dimension of the Box.

Default Value
2.0

Constructor Detail

Boxback to summary
public Box()

Creates a new instance of Box of dimension 2 by 2 by 2.

Boxback to summary
public Box(double width, double height, double depth)

Creates a new instance of Box of dimension width by height by depth.

Parameters
width:double

the width of this box

height:double

the height of this box

depth:double

the depth of this box

Method Detail

createMeshback to summary
pack-priv static TriangleMesh createMesh(float w, float h, float d)
depthPropertyback to summary
public final DoubleProperty depthProperty()
doComputeContainsback to summary
private boolean doComputeContains(double localX, double localY)

Hides javafx.scene.shape.Shape3D.doComputeContains.

doComputeGeomBoundsback to summary
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)

Hides javafx.scene.shape.Shape3D.doComputeGeomBounds.

doComputeIntersectsback to summary
private boolean doComputeIntersects(PickRay pickRay, PickResultChooser pickResult)

Hides javafx.scene.Node.doComputeIntersects.

doCreatePeerback to summary
private NGNode doCreatePeer()
doUpdatePeerback to summary
private void doUpdatePeer()

Hides javafx.scene.shape.Shape3D.doUpdatePeer.

getDepthback to summary
public final double getDepth()
getHeightback to summary
public final double getHeight()
getWidthback to summary
public final double getWidth()
heightPropertyback to summary
public final DoubleProperty heightProperty()
setDepthback to summary
public final void setDepth(double value)
setHeightback to summary
public final void setHeight(double value)
setWidthback to summary
public final void setWidth(double value)
widthPropertyback to summary
public final DoubleProperty widthProperty()
javafx.scene.shape back to summary

private Class Box.BoxKey

extends Key
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final double
pack-priv final double
pack-priv final double

Constructor Summary

AccessConstructor and Description
private
BoxKey(double width, double height, double depth)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Implements abstract javafx.scene.shape.Shape3D.Key.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Implements abstract javafx.scene.shape.Shape3D.Key.hashCode.

Returns a hash code value for this object.

Field Detail

depthback to summary
pack-priv final double depth
heightback to summary
pack-priv final double height
widthback to summary
pack-priv final double width

Constructor Detail

BoxKeyback to summary
private BoxKey(double width, double height, double depth)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Implements abstract javafx.scene.shape.Shape3D.Key.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract javafx.scene.shape.Shape3D.Key.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override