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

#include <Selection.h>

+
+Inheritance diagram for Selection:
+
+
+ + +Graphic + +
+ +

List of all members.

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

+Public Member Functions

 Selection ()
virtual ~Selection ()
virtual void Render (Video *video, DWORD flags)
virtual bool CheckVisibility (Projector &projector)
void UseModel (Model *m)
void UseView (ModelView *v)
Model * GetModel () const
List< Poly > & GetPolys ()
std::vector< DWORD > & GetVerts ()
virtual void Clear ()
void AddPoly (Poly *p)
void AddVert (WORD s, WORD v)
void RemovePoly (Poly *p)
void RemoveVert (WORD s, WORD v)
bool Contains (Poly *p) const
bool Contains (WORD s, WORD v) 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 void Update ()
virtual void SetOrientation (const Matrix &o)
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 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)
+ + + + + +

+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

Model * model
ModelView * model_view
List< Poly > polys
std::vector< DWORD > verts
- 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 35 of file Selection.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
Selection::Selection ()
+
+ +

Definition at line 29 of file Selection.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Selection::~Selection ()
+ 		+virtual
+
+ +

Definition at line 37 of file Selection.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
void Selection::AddPoly (Poly * p)
+
+ +

Definition at line 132 of file Selection.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void Selection::AddVert (WORD s,
WORD v 
)
+
+ +

Definition at line 151 of file Selection.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool Selection::CheckVisibility (Projector & projector)
+ 		+inlinevirtual
+
+ +

Reimplemented from Graphic.

+ +

Definition at line 45 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void Selection::Clear ()
+ 		+inlinevirtual
+
+ +

Definition at line 54 of file Selection.h.

+ +
+
+ +
+
+ + + + + + + + +
bool Selection::Contains (Poly * p) const
+
+ +

Definition at line 145 of file Selection.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
bool Selection::Contains (WORD s,
WORD v 
) const
+
+ +

Definition at line 181 of file Selection.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Model* Selection::GetModel () const
+ 		+inline
+
+ +

Definition at line 50 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Poly>& Selection::GetPolys ()
+ 		+inline
+
+ +

Definition at line 51 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
std::vector<DWORD>& Selection::GetVerts ()
+ 		+inline
+
+ +

Definition at line 52 of file Selection.h.

+ +
+
+ +
+
+ + + + + + + + +
void Selection::RemovePoly (Poly * p)
+
+ +

Definition at line 139 of file Selection.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void Selection::RemoveVert (WORD s,
WORD v 
)
+
+ +

Definition at line 168 of file Selection.cpp.

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

Reimplemented from Graphic.

+ +

Definition at line 44 of file Selection.cpp.

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

Reimplemented from Graphic.

+ +

Definition at line 38 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Selection::UseModel (Model * m)
+ 		+inline
+
+ +

Definition at line 48 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void Selection::UseView (ModelView * v)
+ 		+inline
+
+ +

Definition at line 49 of file Selection.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Model* Selection::model
+ 		+protected
+
+ +

Definition at line 65 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
ModelView* Selection::model_view
+ 		+protected
+
+ +

Definition at line 66 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Poly> Selection::polys
+ 		+protected
+
+ +

Definition at line 67 of file Selection.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
std::vector<DWORD> Selection::verts
+ 		+protected
+
+ +

Definition at line 68 of file Selection.h.

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