javax.media.j3d
Class DirectionalLight
java.lang.Object
|
+--javax.media.j3d.SceneGraphObject
|
+--javax.media.j3d.Node
|
+--javax.media.j3d.Leaf
|
+--javax.media.j3d.Light
|
+--javax.media.j3d.DirectionalLight
- public class DirectionalLight
- extends Light
DirectionalLight is the API part of a directional light object.
Field Summary |
static int |
ALLOW_DIRECTION_READ
Specifies that the Node allows access to its object's direction
information. |
static int |
ALLOW_DIRECTION_WRITE
Specifies that the Node allows writing to its object's direction
information. |
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_PICK,
ALLOW_PICKABLE_READ,
ALLOW_PICKABLE_WRITE,
ENABLE_COLLISION_REPORTING,
ENABLE_PICK_REPORTING |
Method Summary |
Node |
cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. |
void |
duplicateNode(Node originalNode,
boolean forceDuplicate)
Copies all node information from originalNode into
the current node. |
void |
getDirection(Vector3f direction)
Gets this Light's current direction and places it in the parameter specified. |
void |
setDirection(float x,
float y,
float z)
Set light direction. |
void |
setDirection(Vector3f direction)
Set light direction. |
Methods inherited from class javax.media.j3d.Light |
addScope,
getAllScopes,
getColor,
getEnable,
getInfluencingBoundingLeaf,
getInfluencingBounds,
getScope,
insertScope,
numScopes,
removeScope,
setColor,
setEnable,
setInfluencingBoundingLeaf,
setInfluencingBounds,
setScope,
updateNodeReferences |
Methods inherited from class javax.media.j3d.Node |
cloneTree,
cloneTree,
cloneTree,
getBounds,
getBoundsAutoCompute,
getCollidable,
getLocalToVworld,
getLocalToVworld,
getParent,
getPickable,
setBounds,
setBoundsAutoCompute,
setCollidable,
setPickable |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
ALLOW_DIRECTION_READ
public static final int ALLOW_DIRECTION_READ
- Specifies that the Node allows access to its object's direction
information.
ALLOW_DIRECTION_WRITE
public static final int ALLOW_DIRECTION_WRITE
- Specifies that the Node allows writing to its object's direction
information.
DirectionalLight
public DirectionalLight()
- Constructs a DirectionalLight node with default parameters.
The default values are as follows:
DirectionalLight
public DirectionalLight(Color3f color,
Vector3f direction)
- Constructs and initializes a directional light.
- Parameters:
color
- the color of the light sourcedirection
- the direction vector pointing from the light
to the object
DirectionalLight
public DirectionalLight(boolean lightOn,
Color3f color,
Vector3f direction)
- Constructs and initializes a directional light.
- Parameters:
lightOn
- flag indicating whether this light is on or offcolor
- the color of the light sourcedirection
- the direction vector pointing from the light
to the object
setDirection
public final void setDirection(Vector3f direction)
- Set light direction.
- Parameters:
direction
- the new direction- Throws:
- CapabilityNotSetException - if appropriate capability is
not set and this object is part of live or compiled scene graph
setDirection
public final void setDirection(float x,
float y,
float z)
- Set light direction.
- Parameters:
x
- the new X directiony
- the new Y directionz
- the new Z direction- Throws:
- CapabilityNotSetException - if appropriate capability is
not set and this object is part of live or compiled scene graph
getDirection
public final void getDirection(Vector3f direction)
- Gets this Light's current direction and places it in the parameter specified.
- Parameters:
direction
- the vector that will receive this node's direction- Throws:
- CapabilityNotSetException - if appropriate capability is
not set and this object is part of live or compiled scene graph
cloneNode
public Node cloneNode(boolean forceDuplicate)
- Used to create a new instance of the node. This routine is called
by
cloneTree
to duplicate the current node.
- Overrides:
- cloneNode in class Node
- Parameters:
forceDuplicate
- when set to true
, causes the
duplicateOnCloneTree
flag to be ignored. When
false
, the value of each node's
duplicateOnCloneTree
variable determines whether
NodeComponent data is duplicated or copied.- See Also:
Node.cloneTree()
,
Node.cloneNode(boolean)
,
Node.duplicateNode(javax.media.j3d.Node, boolean)
,
NodeComponent.setDuplicateOnCloneTree(boolean)
duplicateNode
public void duplicateNode(Node originalNode,
boolean forceDuplicate)
- Copies all node information from
originalNode
into
the current node. This method is called from the
cloneNode
method which is, in turn, called by the
cloneTree
method.
For any NodeComponent objects
contained by the object being duplicated, each NodeComponent
object's duplicateOnCloneTree
value is used to determine
whether the NodeComponent 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 the
forceDuplicate
parameter in the cloneTree
method to true
.
- Overrides:
- duplicateNode in class Node
- Parameters:
originalNode
- the original node to duplicate.forceDuplicate
- when set to true
, causes the
duplicateOnCloneTree
flag to be ignored. When
false
, the value of each node's
duplicateOnCloneTree
variable determines whether
NodeComponent data is duplicated or copied.- See Also:
Node.cloneTree()
,
Node.cloneNode(boolean)
,
NodeComponent.setDuplicateOnCloneTree(boolean)