From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_camera_director.html | 2233 +++++++++++++++++++++++++++ 1 file changed, 2233 insertions(+) create mode 100644 Doc/doxygen/html/class_camera_director.html (limited to 'Doc/doxygen/html/class_camera_director.html') diff --git a/Doc/doxygen/html/class_camera_director.html b/Doc/doxygen/html/class_camera_director.html new file mode 100644 index 0000000..3106882 --- /dev/null +++ b/Doc/doxygen/html/class_camera_director.html @@ -0,0 +1,2233 @@ + + + + + +Starshatter_Open: CameraDirector Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes | +Static Protected Attributes
+
+
CameraDirector Class Reference
+
+
+ +

#include <CameraDirector.h>

+
+Inheritance diagram for CameraDirector:
+
+
+ + +SimObserver + +
+ +

List of all members.

+ + + +

+Public Types

enum  CAM_MODE {
+  MODE_NONE, +MODE_COCKPIT, +MODE_CHASE, +MODE_TARGET, +
+  MODE_THREAT, +MODE_ORBIT, +MODE_VIRTUAL, +MODE_TRANSLATE, +
+  MODE_ZOOM, +MODE_DOCKING, +MODE_DROP, +MODE_LAST +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CameraDirector ()
virtual ~CameraDirector ()
int operator== (const CameraDirector &that) const
virtual void Reset ()
virtual void SetMode (int m, double trans_time=1)
virtual int GetMode () const
virtual Camera * GetCamera ()
virtual Ship * GetShip ()
virtual void SetShip (Ship *s)
virtual void VirtualHead (double az, double el)
virtual void VirtualHeadOffset (double x, double y, double z)
virtual void VirtualAzimuth (double delta)
virtual void VirtualElevation (double delta)
virtual void ExternalAzimuth (double delta)
virtual void ExternalElevation (double delta)
virtual void ExternalRange (double delta)
virtual void SetOrbitPoint (double az, double el, double range)
virtual void SetOrbitRates (double az_rate, double el_rate, double r_rate)
virtual void CycleViewObject ()
virtual Orbital * GetViewOrbital () const
virtual Ship * GetViewObject () const
virtual void SetViewOrbital (Orbital *orb)
virtual void SetViewObject (Ship *obj, bool quick=false)
virtual void SetViewObjectGroup (ListIter< Ship > group, bool quick=false)
virtual void ClearGroup ()
virtual void ExecFrame (double s)
virtual void Transition (double s)
virtual bool Update (SimObject *obj)
virtual const char * GetObserverName () const
- Public Member Functions inherited from SimObserver
virtual ~SimObserver ()
int operator== (const SimObserver &o) const
virtual void Observe (SimObject *obj)
virtual void Ignore (SimObject *obj)
+ + + + + + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static CameraDirector * GetInstance ()
static int GetCameraMode ()
static void SetCameraMode (int m, double trans_time=1)
static const char * GetModeName ()
static double GetRangeLimit ()
static void SetRangeLimit (double r)
static void SetRangeLimits (double min, double max)
static bool IsViewCentered ()
+ + + + + + + + + +

+Protected Member Functions

virtual void Cockpit (double s)
virtual void Chase (double s)
virtual void Target (double s)
virtual void Threat (double s)
virtual void Virtual (double s)
virtual void Orbit (double s)
virtual void Docking (double s)
virtual void Drop (double s)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

int mode
int requested_mode
int old_mode
Camera camera
Ship * ship
SimRegion * region
Orbital * external_body
Ship * external_ship
List< Ship > external_group
Point external_point
Point base_loc
double virt_az
double virt_el
double virt_x
double virt_y
double virt_z
double azimuth
double elevation
double az_rate
double el_rate
double range_rate
double range
double range_min
double range_max
double base_range
double transition
Sim * sim
HUDView * hud
- Protected Attributes inherited from SimObserver
List< SimObject > observe_list
+ + +

+Static Protected Attributes

static CameraDirector * instance = 0
+

Detailed Description

+
+

Definition at line 32 of file CameraDirector.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum CameraDirector::CAM_MODE
+
+
Enumerator:
+ + + + + + + + + + + + +
MODE_NONE  +
MODE_COCKPIT  +
MODE_CHASE  +
MODE_TARGET  +
MODE_THREAT  +
MODE_ORBIT  +
MODE_VIRTUAL  +
MODE_TRANSLATE  +
MODE_ZOOM  +
MODE_DOCKING  +
MODE_DROP  +
MODE_LAST  +
+
+
+ +

Definition at line 37 of file CameraDirector.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
CameraDirector::CameraDirector ()
+
+ +

Definition at line 48 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
CameraDirector::~CameraDirector ()
+ 		+virtual
+
+ +

Definition at line 61 of file CameraDirector.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Chase (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 907 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraDirector::ClearGroup ()
+ 		+virtual
+
+ +

Definition at line 293 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Cockpit (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 851 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraDirector::CycleViewObject ()
+ 		+virtual
+
+ +

Definition at line 301 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Docking (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 1145 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Drop (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 1191 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::ExecFrame (double s)
+ 		+virtual
+
+ +

Definition at line 694 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::ExternalAzimuth (double delta)
+ 		+virtual
+
+ +

Definition at line 587 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::ExternalElevation (double delta)
+ 		+virtual
+
+ +

Definition at line 599 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::ExternalRange (double delta)
+ 		+virtual
+
+ +

Definition at line 612 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Camera* CameraDirector::GetCamera ()
+ 		+inlinevirtual
+
+ +

Definition at line 74 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CameraDirector::GetCameraMode ()
+ 		+static
+
+ +

Definition at line 247 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
CameraDirector * CameraDirector::GetInstance ()
+ 		+static
+
+ +

Definition at line 38 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int CameraDirector::GetMode () const
+ 		+inlinevirtual
+
+ +

Definition at line 73 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char * CameraDirector::GetModeName ()
+ 		+static
+
+ +

Definition at line 214 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char * CameraDirector::GetObserverName () const
+ 		+virtual
+
+ +

Reimplemented from SimObserver.

+ +

Definition at line 686 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double CameraDirector::GetRangeLimit ()
+ 		+static
+
+ +

Definition at line 269 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Ship* CameraDirector::GetShip ()
+ 		+inlinevirtual
+
+ +

Definition at line 75 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Ship* CameraDirector::GetViewObject () const
+ 		+inlinevirtual
+
+ +

Definition at line 93 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Orbital* CameraDirector::GetViewOrbital () const
+ 		+inlinevirtual
+
+ +

Definition at line 92 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool CameraDirector::IsViewCentered ()
+ 		+static
+
+ +

Definition at line 836 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CameraDirector::operator== (const CameraDirector & that) const
+ 		+inline
+
+ +

Definition at line 58 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Orbit (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 997 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraDirector::Reset ()
+ 		+virtual
+
+ +

Definition at line 70 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraDirector::SetCameraMode (int m,
double trans_time = 1 
)
+ 		+static
+
+ +

Definition at line 260 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraDirector::SetMode (int m,
double trans_time = 1 
)
+ 		+virtual
+
+ +

Definition at line 126 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void CameraDirector::SetOrbitPoint (double az,
double el,
double range 
)
+ 		+virtual
+
+ +

Definition at line 631 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void CameraDirector::SetOrbitRates (double az_rate,
double el_rate,
double r_rate 
)
+ 		+virtual
+
+ +

Definition at line 655 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::SetRangeLimit (double r)
+ 		+static
+
+ +

Definition at line 275 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraDirector::SetRangeLimits (double min,
double max 
)
+ 		+static
+
+ +

Definition at line 282 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::SetShip (Ship * s)
+ 		+virtual
+
+ +

Definition at line 88 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraDirector::SetViewObject (Ship * obj,
bool quick = false 
)
+ 		+virtual
+
+ +

Definition at line 370 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraDirector::SetViewObjectGroup (ListIter< Ship > group,
bool quick = false 
)
+ 		+virtual
+
+ +

Definition at line 453 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::SetViewOrbital (Orbital * orb)
+ 		+virtual
+
+ +

Definition at line 347 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Target (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 943 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Threat (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 989 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Transition (double s)
+ 		+virtual
+
+ +

Definition at line 811 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* CameraDirector::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented from SimObserver.

+ +

Definition at line 35 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool CameraDirector::Update (SimObject * obj)
+ 		+virtual
+
+ +

Reimplemented from SimObserver.

+ +

Definition at line 666 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::Virtual (double s)
+ 		+protectedvirtual
+
+ +

Definition at line 867 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::VirtualAzimuth (double delta)
+ 		+virtual
+
+ +

Definition at line 552 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraDirector::VirtualElevation (double delta)
+ 		+virtual
+
+ +

Definition at line 568 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraDirector::VirtualHead (double az,
double el 
)
+ 		+virtual
+
+ +

Definition at line 516 of file CameraDirector.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void CameraDirector::VirtualHeadOffset (double x,
double y,
double z 
)
+ 		+virtual
+
+ +

Definition at line 542 of file CameraDirector.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double CameraDirector::az_rate
+ 		+protected
+
+ +

Definition at line 140 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::azimuth
+ 		+protected
+
+ +

Definition at line 138 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point CameraDirector::base_loc
+ 		+protected
+
+ +

Definition at line 131 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::base_range
+ 		+protected
+
+ +

Definition at line 146 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Camera CameraDirector::camera
+ 		+protected
+
+ +

Definition at line 121 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::el_rate
+ 		+protected
+
+ +

Definition at line 141 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::elevation
+ 		+protected
+
+ +

Definition at line 139 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Orbital* CameraDirector::external_body
+ 		+protected
+
+ +

Definition at line 126 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Ship> CameraDirector::external_group
+ 		+protected
+
+ +

Definition at line 128 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point CameraDirector::external_point
+ 		+protected
+
+ +

Definition at line 129 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Ship* CameraDirector::external_ship
+ 		+protected
+
+ +

Definition at line 127 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
HUDView* CameraDirector::hud
+ 		+protected
+
+ +

Definition at line 150 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
CameraDirector * CameraDirector::instance = 0
+ 		+staticprotected
+
+ +

Definition at line 152 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraDirector::mode
+ 		+protected
+
+ +

Definition at line 118 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraDirector::old_mode
+ 		+protected
+
+ +

Definition at line 120 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::range
+ 		+protected
+
+ +

Definition at line 143 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::range_max
+ 		+protected
+
+ +

Definition at line 145 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::range_min
+ 		+protected
+
+ +

Definition at line 144 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::range_rate
+ 		+protected
+
+ +

Definition at line 142 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
SimRegion* CameraDirector::region
+ 		+protected
+
+ +

Definition at line 125 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraDirector::requested_mode
+ 		+protected
+
+ +

Definition at line 119 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Ship* CameraDirector::ship
+ 		+protected
+
+ +

Definition at line 123 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Sim* CameraDirector::sim
+ 		+protected
+
+ +

Definition at line 149 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::transition
+ 		+protected
+
+ +

Definition at line 147 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::virt_az
+ 		+protected
+
+ +

Definition at line 133 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::virt_el
+ 		+protected
+
+ +

Definition at line 134 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::virt_x
+ 		+protected
+
+ +

Definition at line 135 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::virt_y
+ 		+protected
+
+ +

Definition at line 136 of file CameraDirector.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraDirector::virt_z
+ 		+protected
+
+ +

Definition at line 137 of file CameraDirector.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1