NavigatorState.NavigatorState Class Reference


Detailed Description

NavigatorState is a ClientState sub-class for holding a transmittable The navigator keeps track of: Position - a 3D point describing the position of the camera LookAt - a 3D point that the camera is pointing to.

It is defined as: viewVector = normalize( lookAt - position ) COI (Center of Interest) - a 3D point describing the center of interest the camera tumbles around the COI, and dolly's towards the COI although the camera does not necessarily look at the COI Roll - how much to rotate/tilt the camera around its view axis

#include <class_navigator_state_1_1_navigator_state.h>

Inheritance diagram for NavigatorState.NavigatorState:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  __eq__ ()
  Returns True if the given client has the same state as this client; False otherwise.
  __ne__ ()
  Returns True if the given client does not have the same state as this client; False otherwise.
  set ()
  Set this state object to be equal to the given state object.
  getLookAt ()
  getPosition ()
  getCOI ()
  getRoll ()
  isOrtho ()
  setLookAt ()
  Position and lookat are not allowed to be the same point.
  setPosition ()
  Position and lookat are not allowed to be the same point.
  setCOI ()
  setRoll ()
  setOrtho ()
  setLookAtFromString ()
  setPositionFromString ()
  setCOIFromString ()
  setLookAtFromStringAndScale ()
  setPositionFromStringAndScale ()
  setCOIFromStringAndScale ()
  setRollFromString ()
  isDefaultNavigation ()
  dump ()

Public Attributes

list  kDefaultHomeLookAt = [ 231.64, 15.27, 64.94 ]
list  kDefaultHomePosition = [ -337.55, -561.09, 234.24 ]
list  kDefaultHomeCOI = [ 0.0, 0.0, 0.0 ]
float  kDefaultHomeRoll = 0.0

Member Function Documentation

NavigatorState.NavigatorState.__init__ ( )
NavigatorState.NavigatorState.__eq__ ( )

Returns True if the given client has the same state as this client; False otherwise.

Reimplemented from ClientState.ClientState.

NavigatorState.NavigatorState.__ne__ ( )

Returns True if the given client does not have the same state as this client; False otherwise.

Reimplemented from ClientState.ClientState.

NavigatorState.NavigatorState.set ( )

Set this state object to be equal to the given state object.

Reimplemented from ClientState.ClientState.

NavigatorState.NavigatorState.getLookAt ( )
NavigatorState.NavigatorState.getPosition ( )
NavigatorState.NavigatorState.getCOI ( )
NavigatorState.NavigatorState.getRoll ( )
NavigatorState.NavigatorState.isOrtho ( )
NavigatorState.NavigatorState.setLookAt ( )

Position and lookat are not allowed to be the same point.

If they are we modify the lookat by adding 1.0 to the y component.

NavigatorState.NavigatorState.setPosition ( )

Position and lookat are not allowed to be the same point.

If they are we modify the lookat by adding 1.0 to the y component.

NavigatorState.NavigatorState.setCOI ( )
NavigatorState.NavigatorState.setRoll ( )
NavigatorState.NavigatorState.setOrtho ( )
NavigatorState.NavigatorState.setLookAtFromString ( )
NavigatorState.NavigatorState.setPositionFromString ( )
NavigatorState.NavigatorState.setCOIFromString ( )
NavigatorState.NavigatorState.setLookAtFromStringAndScale ( )
NavigatorState.NavigatorState.setPositionFromStringAndScale ( )
NavigatorState.NavigatorState.setCOIFromStringAndScale ( )
NavigatorState.NavigatorState.setRollFromString ( )
NavigatorState.NavigatorState.isDefaultNavigation ( )
NavigatorState.NavigatorState.dump ( )

Member Data Documentation


NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState
NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState NavigatorState.NavigatorState