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

#include <ModelView.h>

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

List of all members.

+ + + + +

+Public Types

enum  VIEW_MODE { VIEW_PLAN = 1, +VIEW_FRONT, +VIEW_SIDE, +VIEW_PROJECT + }
enum  FILL_MODE { FILL_WIRE = 1, +FILL_SOLID, +FILL_TEXTURE + }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ModelView (Window *c, Scene *s, DWORD m)
virtual ~ModelView ()
virtual void RenderScene ()
virtual void Render (Graphic *g, DWORD flags)
DWORD GetViewMode () const
void SetViewMode (DWORD m)
DWORD GetFillMode () const
void SetFillMode (DWORD m)
void MoveTo (Point origin)
void MoveBy (double dx, double dy)
void SpinBy (double phi, double theta)
void UseGrid (Grid *g)
void RenderGrid ()
void ZoomNormal ()
CPoint ProjectPoint (Vec3 &p)
- Public Member Functions inherited from CameraView
 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 RenderSceneObjects (bool distant=false)
virtual void RenderForeground ()
virtual void RenderBackground ()
virtual void RenderSprites ()
virtual void RenderLensFlare ()
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 ModelView * FindView (DWORD mode)
- Static Public Member Functions inherited from CameraView
static const char * TYPENAME ()
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

Camera cam
DWORD view_mode
DWORD fill_mode
double az
double el
Grid * grid
- Protected Attributes inherited from CameraView
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
+ + + +

+Additional Inherited Members

- Protected Member Functions inherited from CameraView
virtual void WorldPlaneToView (Plane &plane)
+

Detailed Description

+
+

Definition at line 24 of file ModelView.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum ModelView::FILL_MODE
+
+
Enumerator:
+ + + +
FILL_WIRE  +
FILL_SOLID  +
FILL_TEXTURE  +
+
+
+ +

Definition at line 28 of file ModelView.h.

+ +
+
+ +
+
+ + + + +
enum ModelView::VIEW_MODE
+
+
Enumerator:
+ + + + +
VIEW_PLAN  +
VIEW_FRONT  +
VIEW_SIDE  +
VIEW_PROJECT  +
+
+
+ +

Definition at line 27 of file ModelView.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
ModelView::ModelView (Window * c,
Scene * s,
DWORD m 
)
+
+ +

Definition at line 45 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
ModelView::~ModelView ()
+ 		+virtual
+
+ +

Definition at line 53 of file ModelView.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
ModelView * ModelView::FindView (DWORD mode)
+ 		+static
+
+ +

Definition at line 110 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD ModelView::GetFillMode () const
+ 		+inline
+
+ +

Definition at line 38 of file ModelView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DWORD ModelView::GetViewMode () const
+ 		+inline
+
+ +

Definition at line 36 of file ModelView.h.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void ModelView::MoveBy (double dx,
double dy 
)
+
+ +

Definition at line 145 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void ModelView::MoveTo (Point origin)
+
+ +

Definition at line 121 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + + + + +
CPoint ModelView::ProjectPoint (Vec3 & p)
+
+ +

Definition at line 392 of file ModelView.cpp.

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

Reimplemented from CameraView.

+ +

Definition at line 286 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + + + +
void ModelView::RenderGrid ()
+
+ +

Definition at line 366 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void ModelView::RenderScene ()
+ 		+virtual
+
+ +

Reimplemented from CameraView.

+ +

Definition at line 231 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void ModelView::SetFillMode (DWORD m)
+ 		+inline
+
+ +

Definition at line 39 of file ModelView.h.

+ +
+
+ +
+
+ + + + + + + + +
void ModelView::SetViewMode (DWORD m)
+
+ +

Definition at line 62 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void ModelView::SpinBy (double phi,
double theta 
)
+
+ +

Definition at line 183 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void ModelView::UseGrid (Grid * g)
+
+ +

Definition at line 212 of file ModelView.cpp.

+ +
+
+ +
+
+ + + + + + + +
void ModelView::ZoomNormal ()
+
+ +

Definition at line 218 of file ModelView.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double ModelView::az
+ 		+protected
+
+ +

Definition at line 57 of file ModelView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Camera ModelView::cam
+ 		+protected
+
+ +

Definition at line 54 of file ModelView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double ModelView::el
+ 		+protected
+
+ +

Definition at line 58 of file ModelView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD ModelView::fill_mode
+ 		+protected
+
+ +

Definition at line 56 of file ModelView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Grid* ModelView::grid
+ 		+protected
+
+ +

Definition at line 59 of file ModelView.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD ModelView::view_mode
+ 		+protected
+
+ +

Definition at line 55 of file ModelView.h.

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