Class OrientedShape3D
- java.lang.Object
-
- javax.media.j3d.SceneGraphObject
-
- javax.media.j3d.Node
-
- javax.media.j3d.Leaf
-
- javax.media.j3d.Shape3D
-
- javax.media.j3d.OrientedShape3D
-
public class OrientedShape3D extends Shape3D
The OrientedShape3D leaf node is a Shape3D node that is oriented along a specified axis or about a specified point. It defines an alignment mode and a rotation point or axis. This will cause the local +z axis of the object to point at the viewer's eye position. This is done regardless of the transforms above this OrientedShape3D node in the scene graph. It optionally defines a scale value along with a constant scale enable flag that causes this node to be scale invariant, subject only to its scale.OrientedShape3D is similar in functionality to the Billboard behavior, but OrientedShape3D nodes will orient themselves correctly for each view, and they can be used within a SharedGroup.
If the alignment mode is ROTATE_ABOUT_AXIS, then the rotation will be around the specified axis. If the alignment mode is ROTATE_ABOUT_POINT, then the rotation will be about the specified point, with an additional rotation to align the +y axis of the TransformGroup with the +y axis in the View.
If the constant scale enable flag is set, the object will be drawn the same size in absolute screen coordinates (meters), regardless of the following: any transforms above this OrientedShape3D node in the scene graph, the view scale, the window scale, or the effects of perspective correction. This is done by scaling the geometry about the local origin of this node, such that 1 unit in local coordinates is equal to the number of meters specified by this node's scale value. If the constant scale enable flag is set to false, then the scale is not used. The default scale is 1.0 meters.
OrientedShape3D nodes are ideal for drawing screen-aligned text or for drawing roughly-symmetrical objects. A typical use might consist of a quadrilateral that contains a texture of a tree.
Note that in a multiple View system, picking and interestion test is done with the primary View only.
- Since:
- Java 3D 1.2
- See Also:
Billboard
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALLOW_AXIS_READ
Specifies that this OrientedShape3D node allows reading its alignment axis information.static int
ALLOW_AXIS_WRITE
Specifies that this OrientedShape3D node allows writing its alignment axis information.static int
ALLOW_MODE_READ
Specifies that this OrientedShape3D node allows reading its alignment mode information.static int
ALLOW_MODE_WRITE
Specifies that this OrientedShape3D node allows writing its alignment mode information.static int
ALLOW_POINT_READ
Specifies that this OrientedShape3D node allows reading its rotation point information.static int
ALLOW_POINT_WRITE
Specifies that this OrientedShape3D node allows writing its rotation point information.static int
ALLOW_SCALE_READ
Specifies that this OrientedShape3D node allows reading its scale and constant scale enable information.static int
ALLOW_SCALE_WRITE
Specifies that this OrientedShape3D node allows writing its scale and constant scale enable information.static int
ROTATE_ABOUT_AXIS
Specifies that rotation should be about the specified axis.static int
ROTATE_ABOUT_POINT
Specifies that rotation should be about the specified point and that the children's Y-axis should match the view object's Y-axis.static int
ROTATE_NONE
Specifies that no rotation is done.-
Fields inherited from class javax.media.j3d.Shape3D
ALLOW_APPEARANCE_OVERRIDE_READ, ALLOW_APPEARANCE_OVERRIDE_WRITE, ALLOW_APPEARANCE_READ, ALLOW_APPEARANCE_WRITE, ALLOW_COLLISION_BOUNDS_READ, ALLOW_COLLISION_BOUNDS_WRITE, ALLOW_GEOMETRY_READ, ALLOW_GEOMETRY_WRITE
-
Fields inherited from class javax.media.j3d.Node
ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING
-
-
Constructor Summary
Constructors Constructor Description OrientedShape3D()
Constructs an OrientedShape3D node with default parameters.OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Point3f point)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, and rotation point.OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Point3f point, boolean constantScaleEnable, double scale)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, and rotation point.OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Vector3f axis)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, and axis.OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Vector3f axis, boolean constantScaleEnable, double scale)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, axis, constant scale enable flag, and scale The specified axis must not be parallel to the Z axis--(0,0,z) for any value of z.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Node
cloneNode(boolean forceDuplicate)
Used to create a new instance of the node.void
duplicateNode(Node originalNode, boolean forceDuplicate)
Copies all node information fromoriginalNode
into the current node.void
getAlignmentAxis(javax.vecmath.Vector3f axis)
Retrieves the alignment axis of this OrientedShape3D node, and copies it into the specified vector.int
getAlignmentMode()
Retrieves the alignment mode.boolean
getConstantScaleEnable()
Retrieves the constant scale enable flag.void
getRotationPoint(javax.vecmath.Point3f point)
Retrieves the rotation point of this OrientedShape3D node, and copies it into the specified vector.double
getScale()
Retrieves the scale value for this OrientedShape3D.void
setAlignmentAxis(float x, float y, float z)
Sets the new alignment axis.void
setAlignmentAxis(javax.vecmath.Vector3f axis)
Sets the new alignment axis.void
setAlignmentMode(int mode)
Sets the alignment mode.void
setConstantScaleEnable(boolean constantScaleEnable)
Sets the constant scale enable flag.void
setRotationPoint(float x, float y, float z)
Sets the new rotation point.void
setRotationPoint(javax.vecmath.Point3f point)
Sets the new rotation point.void
setScale(double scale)
Sets the scale for this OrientedShape3D.-
Methods inherited from class javax.media.j3d.Shape3D
addGeometry, getAllGeometries, getAppearance, getAppearanceOverrideEnable, getBounds, getCollisionBounds, getGeometry, getGeometry, indexOfGeometry, insertGeometry, intersect, intersect, intersect, numGeometries, removeAllGeometries, removeGeometry, removeGeometry, setAppearance, setAppearanceOverrideEnable, setCollisionBounds, setGeometry, setGeometry
-
Methods inherited from class javax.media.j3d.Node
cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable
-
Methods inherited from class javax.media.j3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString, updateNodeReferences
-
-
-
-
Field Detail
-
ROTATE_ABOUT_AXIS
public static final int ROTATE_ABOUT_AXIS
Specifies that rotation should be about the specified axis.- See Also:
setAlignmentMode(int)
, Constant Field Values
-
ROTATE_ABOUT_POINT
public static final int ROTATE_ABOUT_POINT
Specifies that rotation should be about the specified point and that the children's Y-axis should match the view object's Y-axis.- See Also:
setAlignmentMode(int)
, Constant Field Values
-
ROTATE_NONE
public static final int ROTATE_NONE
Specifies that no rotation is done. The OrientedShape3D will not be aligned to the view.- Since:
- Java 3D 1.3
- See Also:
setAlignmentMode(int)
, Constant Field Values
-
ALLOW_MODE_READ
public static final int ALLOW_MODE_READ
Specifies that this OrientedShape3D node allows reading its alignment mode information.- See Also:
- Constant Field Values
-
ALLOW_MODE_WRITE
public static final int ALLOW_MODE_WRITE
Specifies that this OrientedShape3D node allows writing its alignment mode information.- See Also:
- Constant Field Values
-
ALLOW_AXIS_READ
public static final int ALLOW_AXIS_READ
Specifies that this OrientedShape3D node allows reading its alignment axis information.- See Also:
- Constant Field Values
-
ALLOW_AXIS_WRITE
public static final int ALLOW_AXIS_WRITE
Specifies that this OrientedShape3D node allows writing its alignment axis information.- See Also:
- Constant Field Values
-
ALLOW_POINT_READ
public static final int ALLOW_POINT_READ
Specifies that this OrientedShape3D node allows reading its rotation point information.- See Also:
- Constant Field Values
-
ALLOW_POINT_WRITE
public static final int ALLOW_POINT_WRITE
Specifies that this OrientedShape3D node allows writing its rotation point information.- See Also:
- Constant Field Values
-
ALLOW_SCALE_READ
public static final int ALLOW_SCALE_READ
Specifies that this OrientedShape3D node allows reading its scale and constant scale enable information.- Since:
- Java 3D 1.3
- See Also:
- Constant Field Values
-
ALLOW_SCALE_WRITE
public static final int ALLOW_SCALE_WRITE
Specifies that this OrientedShape3D node allows writing its scale and constant scale enable information.- Since:
- Java 3D 1.3
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
OrientedShape3D
public OrientedShape3D()
Constructs an OrientedShape3D node with default parameters. The default values are as follows:-
alignment mode : ROTATE_ABOUT_AXIS
alignment axis : Y-axis (0,1,0)
rotation point : (0,0,1)
constant scale enable : false
scale : 1.0
-
OrientedShape3D
public OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Vector3f axis)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, and axis. The specified axis must not be parallel to the Z axis--(0,0,z) for any value of z. It is not possible for the +Z axis to point at the viewer's eye position by rotating about itself. The target transform will be set to the identity if the axis is (0,0,z).- Parameters:
geometry
- the geometry component with which to initialize this shape nodeappearance
- the appearance component of the shape nodemode
- alignment mode, one of: ROTATE_ABOUT_AXIS, ROTATE_ABOUT_POINT, or ROTATE_NONEaxis
- the ray about which the OrientedShape3D rotates
-
OrientedShape3D
public OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Point3f point)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, and rotation point.- Parameters:
geometry
- the geometry component with which to initialize this shape nodeappearance
- the appearance component of the shape nodemode
- alignment mode, one of: ROTATE_ABOUT_AXIS, ROTATE_ABOUT_POINT, or ROTATE_NONEpoint
- the position about which the OrientedShape3D rotates
-
OrientedShape3D
public OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Vector3f axis, boolean constantScaleEnable, double scale)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, axis, constant scale enable flag, and scale The specified axis must not be parallel to the Z axis--(0,0,z) for any value of z. It is not possible for the +Z axis to point at the viewer's eye position by rotating about itself. The target transform will be set to the identity if the axis is (0,0,z).- Parameters:
geometry
- the geometry component with which to initialize this shape nodeappearance
- the appearance component of the shape nodemode
- alignment mode, one of: ROTATE_ABOUT_AXIS, ROTATE_ABOUT_POINT, or ROTATE_NONEaxis
- the ray about which the OrientedShape3D rotatesconstantScaleEnable
- a flag indicating whether to enable constant scalescale
- scale value used when constant scale is enabled- Since:
- Java 3D 1.3
-
OrientedShape3D
public OrientedShape3D(Geometry geometry, Appearance appearance, int mode, javax.vecmath.Point3f point, boolean constantScaleEnable, double scale)
Constructs an OrientedShape3D node with the specified geometry component, appearance component, mode, and rotation point.- Parameters:
geometry
- the geometry component with which to initialize this shape nodeappearance
- the appearance component of the shape nodemode
- alignment mode, one of: ROTATE_ABOUT_AXIS, ROTATE_ABOUT_POINT, or ROTATE_NONEpoint
- the position about which the OrientedShape3D rotatesconstantScaleEnable
- a flag indicating whether to enable constant scalescale
- scale value used when constant scale is enabled- Since:
- Java 3D 1.3
-
-
Method Detail
-
setAlignmentMode
public void setAlignmentMode(int mode)
Sets the alignment mode.- Parameters:
mode
- alignment mode, one of: ROTATE_ABOUT_AXIS, ROTATE_ABOUT_POINT, or ROTATE_NONE- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
getAlignmentMode
public int getAlignmentMode()
Retrieves the alignment mode.- Returns:
- one of: ROTATE_ABOUT_AXIS, ROTATE_ABOUT_POINT, or ROTATE_NONE
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
setAlignmentAxis
public void setAlignmentAxis(javax.vecmath.Vector3f axis)
Sets the new alignment axis. This is the ray about which this OrientedShape3D rotates when the mode is ROTATE_ABOUT_AXIS. The specified axis must not be parallel to the Z axis--(0,0,z) for any value of z. It is not possible for the +Z axis to point at the viewer's eye position by rotating about itself. The target transform will be set to the identity if the axis is (0,0,z).- Parameters:
axis
- the new alignment axis- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
setAlignmentAxis
public void setAlignmentAxis(float x, float y, float z)
Sets the new alignment axis. This is the ray about which this OrientedShape3D rotates when the mode is ROTATE_ABOUT_AXIS. The specified axis must not be parallel to the Z axis--(0,0,z) for any value of z. It is not possible for the +Z axis to point at the viewer's eye position by rotating about itself. The target transform will be set to the identity if the axis is (0,0,z).- Parameters:
x
- the x component of the alignment axisy
- the y component of the alignment axisz
- the z component of the alignment axis- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
getAlignmentAxis
public void getAlignmentAxis(javax.vecmath.Vector3f axis)
Retrieves the alignment axis of this OrientedShape3D node, and copies it into the specified vector.- Parameters:
axis
- the vector that will contain the alignment axis- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
setRotationPoint
public void setRotationPoint(javax.vecmath.Point3f point)
Sets the new rotation point. This is the point about which the OrientedShape3D rotates when the mode is ROTATE_ABOUT_POINT.- Parameters:
point
- the new rotation point- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
setRotationPoint
public void setRotationPoint(float x, float y, float z)
Sets the new rotation point. This is the point about which the OrientedShape3D rotates when the mode is ROTATE_ABOUT_POINT.- Parameters:
x
- the x component of the rotation pointy
- the y component of the rotation pointz
- the z component of the rotation point- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
getRotationPoint
public void getRotationPoint(javax.vecmath.Point3f point)
Retrieves the rotation point of this OrientedShape3D node, and copies it into the specified vector.- Parameters:
point
- the point that will contain the rotation point- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
-
setConstantScaleEnable
public void setConstantScaleEnable(boolean constantScaleEnable)
Sets the constant scale enable flag.- Parameters:
constantScaleEnable
- a flag indicating whether to enable constant scale- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph- Since:
- Java 3D 1.3
-
getConstantScaleEnable
public boolean getConstantScaleEnable()
Retrieves the constant scale enable flag.- Returns:
- the current constant scale enable flag
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph- Since:
- Java 3D 1.3
-
setScale
public void setScale(double scale)
Sets the scale for this OrientedShape3D. This scale is used when the constant scale enable flag is set to true.- Parameters:
scale
- the scale value- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph- Since:
- Java 3D 1.3
-
getScale
public double getScale()
Retrieves the scale value for this OrientedShape3D.- Returns:
- the current scale value
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph- Since:
- Java 3D 1.3
-
cloneNode
public Node cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. This routine is called bycloneTree
to duplicate the current node.cloneNode
should be overridden by any user subclassed objects. All subclasses must have theircloneNode
method consist of the following lines:public Node cloneNode(boolean forceDuplicate) { UserSubClass usc = new UserSubClass(); usc.duplicateNode(this, forceDuplicate); return usc; }
- Overrides:
cloneNode
in classShape3D
- Parameters:
forceDuplicate
- when set totrue
, causes theduplicateOnCloneTree
flag to be ignored. Whenfalse
, the value of each node'sduplicateOnCloneTree
variable determines whether NodeComponent data is duplicated or copied.- See Also:
Node.cloneTree()
,Node.duplicateNode(javax.media.j3d.Node, boolean)
,NodeComponent.setDuplicateOnCloneTree(boolean)
-
duplicateNode
public void duplicateNode(Node originalNode, boolean forceDuplicate)
Copies all node information fromoriginalNode
into the current node. This method is called from thecloneNode
method which is, in turn, called by thecloneTree
method.For any
NodeComponent
objects contained by the object being duplicated, eachNodeComponent
object'sduplicateOnCloneTree
value is used to determine whether theNodeComponent
should be duplicated in the new node or if just a reference to the current node should be placed in the new node. This flag can be overridden by setting theforceDuplicate
parameter in thecloneTree
method totrue
.
NOTE: Applications should not call this method directly. It should only be called by the cloneNode method.- Overrides:
duplicateNode
in classShape3D
- Parameters:
originalNode
- the original node to duplicate.forceDuplicate
- when set totrue
, causes theduplicateOnCloneTree
flag to be ignored. Whenfalse
, the value of each node'sduplicateOnCloneTree
variable determines whether NodeComponent data is duplicated or copied.- Throws:
java.lang.ClassCastException
- if originalNode is not an instance ofShape3D
- See Also:
Node.cloneTree()
,Node.cloneNode(boolean)
,NodeComponent.setDuplicateOnCloneTree(boolean)
-
-