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

#include <DetailSet.h>

+ +

List of all members.

+ + + +

+Public Types

enum  { MAX_DETAIL = 4 + }
+ + + + + + + + + + + + + + +

+Public Member Functions

 DetailSet ()
virtual ~DetailSet ()
int DefineLevel (double r, Graphic *g=0, Point *offset=0, Point *spin=0)
void AddToLevel (int level, Graphic *g, Point *offset=0, Point *spin=0)
int NumLevels () const
int NumModels (int level) const
void ExecFrame (double seconds)
void SetLocation (SimRegion *rgn, const Point &loc)
int GetDetailLevel ()
Graphic * GetRep (int level, int n=0)
Point GetOffset (int level, int n=0)
Point GetSpin (int level, int n=0)
void Destroy ()
+ + +

+Static Public Member Functions

static void SetReference (SimRegion *rgn, const Point &loc)
+ + + + + + + + + + +

+Protected Attributes

List< Graphic > rep [MAX_DETAIL]
List< Point > off [MAX_DETAIL]
double rad [MAX_DETAIL]
List< Point > spin
List< Point > rate
int index
int levels
SimRegion * rgn
Point loc
+ + + +

+Static Protected Attributes

static SimRegion * ref_rgn = 0
static Point ref_loc
+

Detailed Description

+
+

Definition at line 30 of file DetailSet.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
anonymous enum
+
+
Enumerator:
+ +
MAX_DETAIL  +
+
+
+ +

Definition at line 33 of file DetailSet.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
DetailSet::DetailSet ()
+
+ +

Definition at line 28 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DetailSet::~DetailSet ()
+ 		+virtual
+
+ +

Definition at line 38 of file DetailSet.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void DetailSet::AddToLevel (int level,
Graphic * g,
Point * offset = 0,
Point * spin = 0 
)
+
+ +

Definition at line 89 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int DetailSet::DefineLevel (double r,
Graphic * g = 0,
Point * offset = 0,
Point * spin = 0 
)
+
+ +

Definition at line 46 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + +
void DetailSet::Destroy ()
+
+ +

Definition at line 213 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void DetailSet::ExecFrame (double seconds)
+
+ +

Definition at line 134 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + +
int DetailSet::GetDetailLevel ()
+
+ +

Definition at line 161 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Point DetailSet::GetOffset (int level,
int n = 0 
)
+
+ +

Definition at line 193 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Graphic * DetailSet::GetRep (int level,
int n = 0 
)
+
+ +

Definition at line 184 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Point DetailSet::GetSpin (int level,
int n = 0 
)
+
+ +

Definition at line 202 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int DetailSet::NumLevels () const
+ 		+inline
+
+ +

Definition at line 40 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + + + + +
int DetailSet::NumModels (int level) const
+
+ +

Definition at line 123 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void DetailSet::SetLocation (SimRegion * rgn,
const Point & loc 
)
+
+ +

Definition at line 143 of file DetailSet.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void DetailSet::SetReference (SimRegion * rgn,
const Point & loc 
)
+ 		+static
+
+ +

Definition at line 152 of file DetailSet.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
int DetailSet::index
+ 		+protected
+
+ +

Definition at line 61 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int DetailSet::levels
+ 		+protected
+
+ +

Definition at line 62 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point DetailSet::loc
+ 		+protected
+
+ +

Definition at line 64 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Point> DetailSet::off[MAX_DETAIL]
+ 		+protected
+
+ +

Definition at line 55 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double DetailSet::rad[MAX_DETAIL]
+ 		+protected
+
+ +

Definition at line 56 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Point> DetailSet::rate
+ 		+protected
+
+ +

Definition at line 59 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point DetailSet::ref_loc
+ 		+staticprotected
+
+ +

Definition at line 67 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
SimRegion * DetailSet::ref_rgn = 0
+ 		+staticprotected
+
+ +

Definition at line 66 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Graphic> DetailSet::rep[MAX_DETAIL]
+ 		+protected
+
+ +

Definition at line 54 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
SimRegion* DetailSet::rgn
+ 		+protected
+
+ +

Definition at line 63 of file DetailSet.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Point> DetailSet::spin
+ 		+protected
+
+ +

Definition at line 58 of file DetailSet.h.

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