All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.generic.geometry.NavigationInfo 

java.lang.Object
   |
   +----vlc.vrml.generic.geometry.VrmlObject
           |
           +----vlc.vrml.generic.geometry.ChildrenNode
                   |
                   +----vlc.vrml.generic.geometry.BindableNode
                           |
                           +----vlc.vrml.generic.geometry.NavigationInfo
public class NavigationInfo
extends BindableNode
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 NavigationInfo()
Default Constructor.

Method Index

o clone()
Make a clone of this object
o get_avatarSize()
Get the current avatar size properties
o get_headlight()
Get the current headlight setting
o get_speed()
Get the current speed that the user is to travel at
o get_type()
Get the current navigation type
o get_visibilityLimit()
Get the current visibility limit.
o set_avatarSize(float[])
Set the avatarSize property
o set_headlight(boolean)
Turn the headlight on or off
o set_speed(float)
Set the navigation speed.
o set_type(String[])
Set the navigation type.
o set_visibilityLimit(float)
Set the visibility limit for the user.
o writeToStream(int)
Prints the formatted contents of this node to the given stream.

Constructors

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

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_avatarSize 
 public void set_avatarSize(float sizes[])
Set the avatarSize property

Parameters:
sizes - An array of values related to the avatarSize properties. The first three values are:
sizes[0] = avatar's radius
sizes[1] = avatar's eye height
sizes[2] = avatar's step height
More values than this are permitted but are browsre dependent.
o get_avatarSize 
 public float[] get_avatarSize()
Get the current avatar size properties

Returns:
An array of property values
See Also:
set_avatarSize
o set_headlight 
 public void set_headlight(boolean on)
Turn the headlight on or off

Parameters:
on - A value of true will turn the headlight on.
o get_headlight 
 public boolean get_headlight()
Get the current headlight setting

Returns:
The current setting where true is headlight on.
o set_speed 
 public void set_speed(float speed)
Set the navigation speed.

Parameters:
speed - The speed to navigate the scene at in units per second
o get_speed 
 public float get_speed()
Get the current speed that the user is to travel at

Returns:
The user's current speed
o set_type 
 public void set_type(String types[])
Set the navigation type.

Parameters:
types - A list of the current navigation type required in order of preference. The following types are required support "ANY", "WALK", "EXAMINE", "FLY", and "NONE".
o get_type 
 public String[] get_type()
Get the current navigation type

Returns:
an array of strings representing the current navigation types in order of preference
See Also:
set_type
o set_visibilityLimit 
 public void set_visibilityLimit(float limit)
Set the visibility limit for the user. Beyond this distance, nothing will be seen. It represents the far clipping plane.

Parameters:
limit - The maximum distance that the user can see.
o get_visibilityLimit 
 public float get_visibilityLimit()
Get the current visibility limit.

Returns:
The current range
o clone 
 public Object clone()
Make a clone of this object

Returns:
A deep clone copy of this object
Overrides:
clone in class BindableNode 
All Packages  Class Hierarchy  This Package  Previous  Next  Index