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_view.html | 1608 +++++++++++++++++++++++++++++++ 1 file changed, 1608 insertions(+) create mode 100644 Doc/doxygen/html/class_camera_view.html (limited to 'Doc/doxygen/html/class_camera_view.html') diff --git a/Doc/doxygen/html/class_camera_view.html b/Doc/doxygen/html/class_camera_view.html new file mode 100644 index 0000000..20ce76e --- /dev/null +++ b/Doc/doxygen/html/class_camera_view.html @@ -0,0 +1,1608 @@ + + + + + +Starshatter_Open: CameraView Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
CameraView Class Reference
+
+
+ +

#include <CameraView.h>

+
+Inheritance diagram for CameraView:
+
+
+ + +View +ModelView + +
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CameraView (Window *c, Camera *cam, Scene *s)
virtual ~CameraView ()
virtual void Refresh ()
virtual void OnWindowMove ()
virtual void UseCamera (Camera *cam)
virtual void UseScene (Scene *scene)
virtual void LensFlareElements (Bitmap *halo, Bitmap *e1=0, Bitmap *e2=0, Bitmap *e3=0)
virtual void LensFlare (int on, double dim=1)
virtual void SetDepthScale (float scale)
Camera * GetCamera () const
Projector * GetProjector ()
Scene * GetScene () const
virtual void SetFieldOfView (double fov)
virtual double GetFieldOfView () const
virtual void SetProjectionType (DWORD pt)
virtual DWORD GetProjectionType () const
Point Pos () const
Point vrt ()
Point vup ()
Point vpn ()
const Matrix & Orientation () const
Point SceneOffset () const
virtual void TranslateScene ()
virtual void UnTranslateScene ()
virtual void MarkVisibleObjects ()
virtual void MarkVisibleLights (Graphic *g, DWORD flags)
virtual void RenderScene ()
virtual void RenderSceneObjects (bool distant=false)
virtual void RenderForeground ()
virtual void RenderBackground ()
virtual void RenderSprites ()
virtual void RenderLensFlare ()
virtual void Render (Graphic *g, DWORD flags)
virtual void FindDepth (Graphic *g)
virtual int SetInfinite (int i)
- Public Member Functions inherited from View
 View (Window *c)
virtual ~View ()
int operator== (const View &that) const
virtual void OnShow ()
virtual void OnHide ()
virtual void SetWindow (Window *w)
virtual Window * GetWindow ()
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + +

+Protected Member Functions

virtual void WorldPlaneToView (Plane &plane)
+ + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

Camera * camera
Scene * scene
Video * video
Point camera_loc
Vec3 cvrt
Vec3 cvup
Vec3 cvpn
Projector projector
int infinite
int width
int height
DWORD projection_type
int lens_flare_enable
double lens_flare_dim
Bitmap * halo_bitmap
Bitmap * elem_bitmap [3]
List< Graphic > graphics
- Protected Attributes inherited from View
Window * window
+

Detailed Description

+
+

Definition at line 35 of file CameraView.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
CameraView::CameraView (Window * c,
Camera * cam,
Scene * s 
)
+
+ +

Definition at line 41 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
CameraView::~CameraView ()
+ 		+virtual
+
+ +

Definition at line 61 of file CameraView.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::FindDepth (Graphic * g)
+ 		+virtual
+
+ +

Definition at line 166 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Camera* CameraView::GetCamera () const
+ 		+inline
+
+ +

Definition at line 53 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double CameraView::GetFieldOfView () const
+ 		+virtual
+
+ +

Definition at line 94 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD CameraView::GetProjectionType () const
+ 		+virtual
+
+ +

Definition at line 107 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Projector* CameraView::GetProjector ()
+ 		+inline
+
+ +

Definition at line 54 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Scene* CameraView::GetScene () const
+ 		+inline
+
+ +

Definition at line 55 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraView::LensFlare (int on,
double dim = 1 
)
+ 		+virtual
+
+ +

Definition at line 128 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void CameraView::LensFlareElements (Bitmap * halo,
Bitmap * e1 = 0,
Bitmap * e2 = 0,
Bitmap * e3 = 0 
)
+ 		+virtual
+
+ +

Definition at line 135 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraView::MarkVisibleLights (Graphic * g,
DWORD flags 
)
+ 		+virtual
+
+ +

Definition at line 332 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::MarkVisibleObjects ()
+ 		+virtual
+
+ +

Definition at line 309 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::OnWindowMove ()
+ 		+virtual
+
+ +

Reimplemented from View.

+ +

Definition at line 113 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Matrix& CameraView::Orientation () const
+ 		+inline
+
+ +

Definition at line 65 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point CameraView::Pos () const
+ 		+inline
+
+ +

Definition at line 61 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::Refresh ()
+ 		+virtual
+
+ +

Reimplemented from View.

+ +

Definition at line 184 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CameraView::Render (Graphic * g,
DWORD flags 
)
+ 		+virtual
+
+ +

Reimplemented in ModelView.

+ +

Definition at line 676 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::RenderBackground ()
+ 		+virtual
+
+ +

Definition at line 376 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::RenderForeground ()
+ 		+virtual
+
+ +

Definition at line 417 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::RenderLensFlare ()
+ 		+virtual
+
+ +

Definition at line 693 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::RenderScene ()
+ 		+virtual
+
+ +

Reimplemented in ModelView.

+ +

Definition at line 534 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::RenderSceneObjects (bool distant = false)
+ 		+virtual
+
+ +

Definition at line 574 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::RenderSprites ()
+ 		+virtual
+
+ +

Definition at line 492 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point CameraView::SceneOffset () const
+ 		+inline
+
+ +

Definition at line 67 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::SetDepthScale (float scale)
+ 		+virtual
+
+ +

Definition at line 802 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::SetFieldOfView (double fov)
+ 		+virtual
+
+ +

Definition at line 88 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CameraView::SetInfinite (int i)
+ 		+virtual
+
+ +

Definition at line 153 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::SetProjectionType (DWORD pt)
+ 		+virtual
+
+ +

Definition at line 100 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::TranslateScene ()
+ 		+virtual
+
+ +

Definition at line 229 of file CameraView.cpp.

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

Reimplemented from View.

+ +

Definition at line 38 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CameraView::UnTranslateScene ()
+ 		+virtual
+
+ +

Definition at line 269 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::UseCamera (Camera * cam)
+ 		+virtual
+
+ +

Definition at line 68 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::UseScene (Scene * scene)
+ 		+virtual
+
+ +

Definition at line 79 of file CameraView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point CameraView::vpn ()
+ 		+inline
+
+ +

Definition at line 64 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point CameraView::vrt ()
+ 		+inline
+
+ +

Definition at line 62 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point CameraView::vup ()
+ 		+inline
+
+ +

Definition at line 63 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CameraView::WorldPlaneToView (Plane & plane)
+ 		+protectedvirtual
+
+ +

Definition at line 787 of file CameraView.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Camera* CameraView::camera
+ 		+protected
+
+ +

Definition at line 87 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point CameraView::camera_loc
+ 		+protected
+
+ +

Definition at line 93 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3 CameraView::cvpn
+ 		+protected
+
+ +

Definition at line 96 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3 CameraView::cvrt
+ 		+protected
+
+ +

Definition at line 94 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3 CameraView::cvup
+ 		+protected
+
+ +

Definition at line 95 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* CameraView::elem_bitmap[3]
+ 		+protected
+
+ +

Definition at line 108 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Graphic> CameraView::graphics
+ 		+protected
+
+ +

Definition at line 110 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* CameraView::halo_bitmap
+ 		+protected
+
+ +

Definition at line 107 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraView::height
+ 		+protected
+
+ +

Definition at line 101 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraView::infinite
+ 		+protected
+
+ +

Definition at line 99 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double CameraView::lens_flare_dim
+ 		+protected
+
+ +

Definition at line 106 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraView::lens_flare_enable
+ 		+protected
+
+ +

Definition at line 105 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD CameraView::projection_type
+ 		+protected
+
+ +

Definition at line 102 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Projector CameraView::projector
+ 		+protected
+
+ +

Definition at line 98 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Scene* CameraView::scene
+ 		+protected
+
+ +

Definition at line 88 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Video* CameraView::video
+ 		+protected
+
+ +

Definition at line 89 of file CameraView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CameraView::width
+ 		+protected
+
+ +

Definition at line 100 of file CameraView.h.

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