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

#include <Grid.h>

+
+Inheritance diagram for Grid:
+
+
+ + +Graphic +Graphic + +
+ +

List of all members.

+ + + + + + +

+Public Types

enum  PLANE { GRID_XY, +GRID_XZ, +GRID_YZ + }
- Public Types inherited from Graphic
enum  TYPE {
+  OTHER, +SOLID, +SPRITE, +BOLT, +
+  QUAD +
+ }
enum  RENDER_FLAGS {
+  RENDER_SOLID = 0x0001, +RENDER_ALPHA = 0x0002, +RENDER_ADDITIVE = 0x0004, +RENDER_FIRST_LIGHT = 0x1000, +
+  RENDER_ADD_LIGHT = 0x2000 +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Grid ()
virtual ~Grid ()
CPoint & Snap (CPoint &p)
bool IsSnap () const
bool IsShow () const
void SetSnap (bool s)
void SetShow (bool s)
void SetSize (int x, int y=0)
void SetSkip (int x, int y=0)
void ShowMinor (bool show)
void ShowPlane (int p)
void ShowReference (bool show)
const char * GetReferencePlan () const
void SetReferencePlan (const char *fname)
const char * GetReferenceFront () const
void SetReferenceFront (const char *fname)
const char * GetReferenceSide () const
void SetReferenceSide (const char *fname)
int GetSize () const
virtual void Render (Video *video, DWORD flags)
virtual void RenderReference (Video *video)
 Grid (int size, int step)
virtual ~Grid ()
virtual void Render (Video *video, DWORD flags)
virtual int CollidesWith (Graphic &o)
- Public Member Functions inherited from Graphic
 Graphic ()
virtual ~Graphic ()
int operator== (const Graphic &g) const
int operator< (const Graphic &g) const
int operator<= (const Graphic &g) const
virtual void Update ()
virtual void SetOrientation (const Matrix &o)
int Identity () const
const char * Name () const
bool IsVisible () const
void SetVisible (bool v)
float Radius () const
Point Location () const
virtual void MoveTo (const Point &p)
virtual void TranslateBy (const Point &ref)
virtual float Depth () const
virtual void SetDepth (float d)
virtual int IsInfinite () const
virtual void SetInfinite (bool b)
virtual int IsForeground () const
virtual void SetForeground (bool f)
virtual int IsBackground () const
virtual void SetBackground (bool b)
virtual int Hidden () const
virtual int Life () const
virtual void Destroy ()
virtual void Hide ()
virtual void Show ()
virtual bool Luminous () const
virtual void SetLuminous (bool l)
virtual bool Translucent () const
virtual bool CastsShadow () const
virtual void SetShadow (bool s)
virtual bool IsSolid () const
virtual bool IsSprite () const
virtual bool IsBolt () const
virtual bool IsQuad () const
virtual void ProjectScreenRect (Projector *p)
const Rect & ScreenRect () const
virtual Scene * GetScene () const
virtual void SetScene (Scene *s)
virtual int CheckRayIntersection (Point pt, Point vpn, double len, Point &ipt, bool treat_translucent_polys_as_solid=true)
virtual bool CheckVisibility (Projector &projector)
+ + + +

+Protected Member Functions

int snapto (int i, int dim)
virtual void DrawLine (Video *video, Point &p1, Point &p2, Color c)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

bool show
bool show_ref
bool snap
bool minor
int x_size
int y_size
int x_skip
int y_skip
int plane
Vec3 * x_major
Vec3 * x_minor
Vec3 * y_major
Vec3 * y_minor
Bitmap * bmp_plan
Bitmap * bmp_front
Bitmap * bmp_side
int size
int step
int drawn
- Protected Attributes inherited from Graphic
int id
Point loc
float depth
float radius
int life
bool visible
bool infinite
bool foreground
bool background
bool hidden
bool trans
bool shadow
bool luminous
Rect screen_rect
Scene * scene
char name [32]
+ + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from Graphic
static const char * TYPENAME ()
static int Nearer (Graphic *a, Graphic *b)
static int Farther (Graphic *a, Graphic *b)
- Static Protected Attributes inherited from Graphic
static int id_key = 1
+

Detailed Description

+
+

Definition at line 24 of file Grid.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum Grid::PLANE
+
+
Enumerator:
+ + + +
GRID_XY  +
GRID_XZ  +
GRID_YZ  +
+
+
+ +

Definition at line 27 of file Grid.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
Grid::Grid ()
+
+ +

Definition at line 39 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Grid::~Grid ()
+ 		+virtual
+
+ +

Definition at line 61 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Grid::Grid (int size,
int step 
)
+
+ +

Definition at line 27 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Grid::~Grid ()
+ 		+virtual
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
int Grid::CollidesWith (Graphic & o)
+ 		+virtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 38 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Grid::DrawLine (Video * video,
Point & p1,
Point & p2,
Color c 
)
+ 		+protectedvirtual
+
+ +

Definition at line 84 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * Grid::GetReferenceFront () const
+
+ +

Definition at line 92 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * Grid::GetReferencePlan () const
+
+ +

Definition at line 72 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * Grid::GetReferenceSide () const
+
+ +

Definition at line 112 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Grid::GetSize () const
+ 		+inline
+
+ +

Definition at line 51 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool Grid::IsShow () const
+ 		+inline
+
+ +

Definition at line 35 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool Grid::IsSnap () const
+ 		+inline
+
+ +

Definition at line 34 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void Grid::Render (Video * video,
DWORD flags 
)
+ 		+virtual
+
+ +

Reimplemented from Graphic.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void Grid::Render (Video * video,
DWORD flags 
)
+ 		+virtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 132 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Grid::RenderReference (Video * video)
+ 		+virtual
+
+ +

Definition at line 212 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Grid::SetReferenceFront (const char * fname)
+
+ +

Definition at line 101 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Grid::SetReferencePlan (const char * fname)
+
+ +

Definition at line 81 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Grid::SetReferenceSide (const char * fname)
+
+ +

Definition at line 121 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Grid::SetShow (bool s)
+ 		+inline
+
+ +

Definition at line 37 of file Grid.h.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void Grid::SetSize (int x,
int y = 0 
)
+
+ +

Definition at line 332 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void Grid::SetSkip (int x,
int y = 0 
)
+
+ +

Definition at line 341 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Grid::SetSnap (bool s)
+ 		+inline
+
+ +

Definition at line 36 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Grid::ShowMinor (bool show)
+ 		+inline
+
+ +

Definition at line 40 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Grid::ShowPlane (int p)
+ 		+inline
+
+ +

Definition at line 41 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Grid::ShowReference (bool show)
+ 		+inline
+
+ +

Definition at line 42 of file Grid.h.

+ +
+
+ +
+
+ + + + + + + + +
CPoint & Grid::Snap (CPoint & p)
+
+ +

Definition at line 307 of file Grid.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int Grid::snapto (int i,
int dim 
)
+ 		+protected
+
+ +

Definition at line 318 of file Grid.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Bitmap* Grid::bmp_front
+ 		+protected
+
+ +

Definition at line 75 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* Grid::bmp_plan
+ 		+protected
+
+ +

Definition at line 74 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* Grid::bmp_side
+ 		+protected
+
+ +

Definition at line 76 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::drawn
+ 		+protected
+
+ +

Definition at line 44 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Grid::minor
+ 		+protected
+
+ +

Definition at line 63 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::plane
+ 		+protected
+
+ +

Definition at line 67 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Grid::show
+ 		+protected
+
+ +

Definition at line 60 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Grid::show_ref
+ 		+protected
+
+ +

Definition at line 61 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::size
+ 		+protected
+
+ +

Definition at line 42 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Grid::snap
+ 		+protected
+
+ +

Definition at line 62 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::step
+ 		+protected
+
+ +

Definition at line 43 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3* Grid::x_major
+ 		+protected
+
+ +

Definition at line 69 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3* Grid::x_minor
+ 		+protected
+
+ +

Definition at line 70 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::x_size
+ 		+protected
+
+ +

Definition at line 65 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::x_skip
+ 		+protected
+
+ +

Definition at line 66 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3* Grid::y_major
+ 		+protected
+
+ +

Definition at line 71 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3* Grid::y_minor
+ 		+protected
+
+ +

Definition at line 72 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::y_size
+ 		+protected
+
+ +

Definition at line 65 of file Grid.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Grid::y_skip
+ 		+protected
+
+ +

Definition at line 66 of file Grid.h.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • D:/SRC/StarshatterSVN/Magic2/Grid.h
    • +
  • D:/SRC/StarshatterSVN/Stars45/Grid.h
    • +
  • D:/SRC/StarshatterSVN/Magic2/Grid.cpp
    • +
  • D:/SRC/StarshatterSVN/Stars45/Grid.cpp
    • +
+
+
+ + + + -- cgit v1.1