All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.external.geometry.SpotLight

java.lang.Object
   |
   +----vlc.vrml.generic.geometry.VrmlObject
           |
           +----vlc.vrml.external.geometry.VrmlObject
                   |
                   +----vlc.vrml.external.geometry.ChildrenNode
                           |
                           +----vlc.vrml.external.geometry.Light
                                   |
                                   +----vlc.vrml.external.geometry.SpotLight

public class SpotLight
extends Light
JVerge

Version:
0.8 (beta 4) Copyright 1997 The Virtual Light Company under the GNU LGPL

The latest information and bugs in JVerge can be found at http://www.vlc.com.au/JVerge

For definition of the Anchor node please see the VRML 97 Anchor specification

Author:
Justin Couch justin@vlc.com.au

Constructor Index

 o SpotLight()
Default Constructor.
 o SpotLight(Browser)
Default Constructor when you wish to supply your own Browser reference.

Method Index

 o clone()
Make a clone of this object
 o get_attenuation()
Get the attenuation coefficients
 o get_beamWidth()
Get the current beam width of the light.
 o get_cutOffAngle()
Get the cutoff angle of the light.
 o get_direction()
Get the direction that this light is pointing.
 o get_location()
Get the location of the light in the local coordinate system
 o get_radius()
Get the current maximum radius of the light.
 o set_attenuation(float[])
Set the attenuation coefficients
 o set_beamWidth(float)
Set the beam width of the light.
 o set_cutOffAngle(float)
Set the cutoff angle of the light.
 o set_direction(float[])
Set the direction that this light is to point.
 o set_location(float[])
Set the location of the light in the local coordinate system
 o set_radius(float)
Set the maximum radius of the light.
 o writeToStream(int)
Prints the formatted contents of this node to the given stream.

Constructors

 o SpotLight
 public SpotLight()
Default Constructor. Creates a default SpotLight

 o SpotLight
 public SpotLight(Browser b)
Default Constructor when you wish to supply your own Browser reference. Creates a default SpotLight

Methods

 o writeToStream
 public void writeToStream(int indent)
Prints the formatted contents of this node to the given stream.

Parameters:
indent - The number of spaces to indent this node in the string
Overrides:
writeToStream in class VrmlObject
 o set_attenuation
 public void set_attenuation(float val[])
Set the attenuation coefficients

Parameters:
val - 3 values of the coefficients
 o get_attenuation
 public float[] get_attenuation()
Get the attenuation coefficients

Returns:
3 values of the coefficients
 o set_location
 public void set_location(float val[])
Set the location of the light in the local coordinate system

Parameters:
val - The position where val[0] = x, val[1] = y, val[2] = z
 o get_location
 public float[] get_location()
Get the location of the light in the local coordinate system

Returns:
The position where val[0] = x, val[1] = y, val[2] = z
 o set_radius
 public void set_radius(float val)
Set the maximum radius of the light.

Parameters:
val - The radius in units
 o get_radius
 public float get_radius()
Get the current maximum radius of the light.

Returns:
The radius.
 o set_beamWidth
 public void set_beamWidth(float val)
Set the beam width of the light. This is the minimum angle for full intensity of the light.

Parameters:
val - The angle from the centre direction in radians.
 o get_beamWidth
 public float get_beamWidth()
Get the current beam width of the light.

Returns:
The angle from the centre direction in radians.
 o set_cutOffAngle
 public void set_cutOffAngle(float val)
Set the cutoff angle of the light. This is the maximum angle for displaying any lighting effects

Parameters:
val - The angle from the centre direction in radians.
 o get_cutOffAngle
 public float get_cutOffAngle()
Get the cutoff angle of the light.

Returns:
The angle from the centre direction in radians.
 o set_direction
 public void set_direction(float val[])
Set the direction that this light is to point. The vector points in the required direction relative to the origin. From the default viewpoint of looking along -Z a direction of -1 -1 -1 would shine light from above your right shoulder

Parameters:
val - The direction. where val[0] = x, val[1] = y, val[2] = z
 o get_direction
 public float[] get_direction()
Get the direction that this light is pointing.

Returns:
The direction. where val[0] = x, val[1] = y, val[2] = z
 o clone
 public Object clone()
Make a clone of this object

Returns:
A deep clone copy of this object
Overrides:
clone in class VrmlObject

All Packages  Class Hierarchy  This Package  Previous  Next  Index