|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Light
javax.media.j3d.PointLight
javax.media.j3d.SpotLight
public class SpotLight
The SpotLight object specifies an attenuated light source at a fixed point in space that radiates light in a specified direction from the light source. A SpotLight has the same attributes as a PointLight node, with the addition of the following:
Field Summary | |
---|---|
static int |
ALLOW_CONCENTRATION_READ
Specifies that the Node allows reading its spot lights concentration information. |
static int |
ALLOW_CONCENTRATION_WRITE
Specifies that the Node allows writing to its spot lights concentration information. |
static int |
ALLOW_DIRECTION_READ
Specifies that the Node allows reading its spot lights direction information. |
static int |
ALLOW_DIRECTION_WRITE
Specifies that the Node allows writing to its spot lights direction information. |
static int |
ALLOW_SPREAD_ANGLE_READ
Specifies that the Node allows reading its spot lights spread angle information. |
static int |
ALLOW_SPREAD_ANGLE_WRITE
Specifies that the Node allows writing to its spot lights spread angle information. |
private static int[] |
readCapabilities
|
Fields inherited from class javax.media.j3d.PointLight |
---|
ALLOW_ATTENUATION_READ, ALLOW_ATTENUATION_WRITE, ALLOW_POSITION_READ, ALLOW_POSITION_WRITE |
Fields inherited from class javax.media.j3d.Light |
---|
ALLOW_COLOR_READ, ALLOW_COLOR_WRITE, ALLOW_INFLUENCING_BOUNDS_READ, ALLOW_INFLUENCING_BOUNDS_WRITE, ALLOW_SCOPE_READ, ALLOW_SCOPE_WRITE, ALLOW_STATE_READ, ALLOW_STATE_WRITE |
Fields inherited from class javax.media.j3d.SceneGraphObject |
---|
nodeHashtable, retained |
Constructor Summary | |
---|---|
SpotLight()
Constructs a SpotLight node with default parameters. |
|
SpotLight(boolean lightOn,
Color3f color,
Point3f position,
Point3f attenuation,
Vector3f direction,
float spreadAngle,
float concentration)
Constructs and initializes a SpotLight node using the specified parameters. |
|
SpotLight(Color3f color,
Point3f position,
Point3f attenuation,
Vector3f direction,
float spreadAngle,
float concentration)
Constructs and initializes a SpotLight node using the specified parameters. |
Method Summary | |
---|---|
Node |
cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. |
(package private) void |
createRetained()
Creates the retained mode SpotLightRetained object that this SpotLight component object will point to. |
(package private) void |
duplicateAttributes(Node originalNode,
boolean forceDuplicate)
Copies all SpotLight information from originalNode into
the current node. |
float |
getConcentration()
Gets spot light concentration. |
void |
getDirection(Vector3f direction)
Gets this Light's current direction and places it in the parameter specified. |
float |
getSpreadAngle()
Gets spot light spread angle. |
void |
setConcentration(float concentration)
Sets spot light concentration. |
void |
setDirection(float x,
float y,
float z)
Sets light direction. |
void |
setDirection(Vector3f direction)
Sets this Light's current direction and places it in the parameter specified. |
void |
setSpreadAngle(float spreadAngle)
Sets spot light spread angle. |
Methods inherited from class javax.media.j3d.PointLight |
---|
getAttenuation, getPosition, setAttenuation, setAttenuation, setPosition, setPosition |
Methods inherited from class javax.media.j3d.Light |
---|
addScope, getAllScopes, getColor, getEnable, getInfluencingBoundingLeaf, getInfluencingBounds, getScope, indexOfScope, insertScope, numScopes, removeAllScopes, removeScope, removeScope, setColor, setEnable, setInfluencingBoundingLeaf, setInfluencingBounds, setScope, updateNodeReferences |
Methods inherited from class javax.media.j3d.Node |
---|
checkDuplicateNode, checkForCycle, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable |
Methods inherited from class javax.media.j3d.SceneGraphObject |
---|
capabilityBitsEmpty, checkForLiveOrCompiled, clearCapability, clearCapabilityIsFrequent, clearLive, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getNamePrefix, getNodeComponent, getUserData, isCompiled, isLive, isLiveOrCompiled, setCapability, setCapabilityIsFrequent, setCompiled, setDefaultReadCapabilities, setLive, setName, setUserData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ALLOW_SPREAD_ANGLE_WRITE
public static final int ALLOW_SPREAD_ANGLE_READ
public static final int ALLOW_CONCENTRATION_WRITE
public static final int ALLOW_CONCENTRATION_READ
public static final int ALLOW_DIRECTION_WRITE
public static final int ALLOW_DIRECTION_READ
private static final int[] readCapabilities
Constructor Detail |
---|
public SpotLight()
public SpotLight(Color3f color, Point3f position, Point3f attenuation, Vector3f direction, float spreadAngle, float concentration)
color
- the color of the light sourceposition
- the position of the light in three-spaceattenuation
- the attenuation (constant, linear, quadratic)
of the lightdirection
- the direction of the lightspreadAngle
- the spread angle of the lightconcentration
- the concentration of the lightpublic SpotLight(boolean lightOn, Color3f color, Point3f position, Point3f attenuation, Vector3f direction, float spreadAngle, float concentration)
lightOn
- flag indicating whether this light is on or offcolor
- the color of the light sourceposition
- the position of the light in three-spaceattenuation
- the attenuation (constant, linear, quadratic) of the lightdirection
- the direction of the lightspreadAngle
- the spread angle of the lightconcentration
- the concentration of the lightMethod Detail |
---|
void createRetained()
createRetained
in class PointLight
public void setSpreadAngle(float spreadAngle)
spreadAngle
- the new spread angle for spot light
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graph.public float getSpreadAngle()
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graphpublic void setConcentration(float concentration)
concentration
- the new concentration for spot light
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graphpublic float getConcentration()
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graphpublic void setDirection(float x, float y, float z)
x
- the new X directiony
- the new Y directionz
- the new Z direction
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graphpublic void setDirection(Vector3f direction)
direction
- the vector that will receive this node's direction
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graphpublic void getDirection(Vector3f direction)
direction
- the vector that will receive this node's direction
CapabilityNotSetException
- if appropriate capability is
not set and this object is part of live or compiled scene graphpublic Node cloneNode(boolean forceDuplicate)
cloneTree
to duplicate the current node.
cloneNode
in class PointLight
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.Node.cloneTree()
,
Node.cloneNode(boolean)
,
Node.duplicateNode(javax.media.j3d.Node, boolean)
,
NodeComponent.setDuplicateOnCloneTree(boolean)
void duplicateAttributes(Node originalNode, boolean forceDuplicate)
originalNode
into
the current node. This method is called from the
cloneNode
method which is, in turn, called by the
cloneTree
method.
duplicateAttributes
in class PointLight
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.
RestrictedAccessException
- if this object is part of a live
or compiled scenegraph.Node.duplicateNode(javax.media.j3d.Node, boolean)
,
Node.cloneTree()
,
NodeComponent.setDuplicateOnCloneTree(boolean)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |