org.j3d.ui.navigation
Class ViewpointData

java.lang.Object
  org.j3d.ui.navigation.ViewpointData

public class ViewpointData
extends java.lang.Object

A class to represent viewpoint information so that we can put it on screen, move around to it etc etc.

Does not include location information for a viewpoint. It expects a derived class for the individual renderer-type will be created that contains the specific transformation structure.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Field Summary

int	id An identifier used to know which view data this is
java.lang.String	name A string representing a name of the viewpoint.
boolean	selected Flag indicating this is the currently selected viewpoint
java.lang.Object	userData User specific data they can associate with this viewpoint

Constructor Summary

ViewpointData(java.lang.String name, int id)
Create a new data object initialised to the set of values.

Method Summary

java.lang.String

toString() Return a string representation of this viewpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

A string representing a name of the viewpoint. For screen display

id

public int id

An identifier used to know which view data this is

selected

public boolean selected

Flag indicating this is the currently selected viewpoint

userData

public java.lang.Object userData

User specific data they can associate with this viewpoint

Constructor Detail

ViewpointData

public ViewpointData(java.lang.String name,
                     int id)

Create a new data object initialised to the set of values.

Parameters:

name - The name to use

id - The id of this viewpoint

Method Detail

toString

public java.lang.String toString()

Return a string representation of this viewpoint. Just returns the name string.

Overrides:

toString in class java.lang.Object

Returns:

The name of this viewpoint