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

#include <Bolt.h>

+
+Inheritance diagram for Bolt:
+
+
+ + +Graphic + +
+ +

List of all members.

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

+Public Member Functions

 Bolt (double len=16, double wid=1, Bitmap *tex=0, int share=0)
virtual ~Bolt ()
virtual void Render (Video *video, DWORD flags)
virtual void Update ()
virtual void SetOrientation (const Matrix &o)
void SetDirection (const Point &v)
void SetEndPoints (const Point &from, const Point &to)
void SetTextureOffset (double from, double to)
virtual void TranslateBy (const Point &ref)
double Shade () const
void SetShade (double s)
virtual bool IsBolt () const
- 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 int CollidesWith (Graphic &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 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 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)
+ + + + + +

+Static Public Member Functions

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

+Protected Attributes

double length
double width
double shade
Poly poly
Material mtl
VertexSet vset
Bitmap * texture
int shared
Point vpn
Point origin
- 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

- 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 +
+ }
- Static Protected Attributes inherited from Graphic
static int id_key = 1
+

Detailed Description

+
+

Definition at line 23 of file Bolt.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Bolt::Bolt (double len = 16,
double wid = 1,
Bitmap * tex = 0,
int share = 0 
)
+
+ +

Definition at line 25 of file Bolt.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Bolt::~Bolt ()
+ 		+virtual
+
+ +

Definition at line 81 of file Bolt.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool Bolt::IsBolt () const
+ 		+inlinevirtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 45 of file Bolt.h.

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

Reimplemented from Graphic.

+ +

Definition at line 88 of file Bolt.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void Bolt::SetDirection (const Point & v)
+
+ +

Definition at line 151 of file Bolt.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void Bolt::SetEndPoints (const Point & from,
const Point & to 
)
+
+ +

Definition at line 158 of file Bolt.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Bolt::SetOrientation (const Matrix & o)
+ 		+virtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 144 of file Bolt.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Bolt::SetShade (double s)
+ 		+inline
+
+ +

Definition at line 44 of file Bolt.h.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void Bolt::SetTextureOffset (double from,
double to 
)
+
+ +

Definition at line 168 of file Bolt.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double Bolt::Shade () const
+ 		+inline
+
+ +

Definition at line 43 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Bolt::TranslateBy (const Point & ref)
+ 		+virtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 135 of file Bolt.cpp.

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

Reimplemented from Graphic.

+ +

Definition at line 26 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Bolt::Update ()
+ 		+virtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 128 of file Bolt.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double Bolt::length
+ 		+protected
+
+ +

Definition at line 48 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Material Bolt::mtl
+ 		+protected
+
+ +

Definition at line 53 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point Bolt::origin
+ 		+protected
+
+ +

Definition at line 59 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Poly Bolt::poly
+ 		+protected
+
+ +

Definition at line 52 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Bolt::shade
+ 		+protected
+
+ +

Definition at line 50 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Bolt::shared
+ 		+protected
+
+ +

Definition at line 56 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* Bolt::texture
+ 		+protected
+
+ +

Definition at line 55 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point Bolt::vpn
+ 		+protected
+
+ +

Definition at line 58 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
VertexSet Bolt::vset
+ 		+protected
+
+ +

Definition at line 54 of file Bolt.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Bolt::width
+ 		+protected
+
+ +

Definition at line 49 of file Bolt.h.

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