File: DrawableObject.h

package info (click to toggle)
transcend 0.3.dfsg2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, jessie, jessie-kfreebsd, stretch
  • size: 5,796 kB
  • ctags: 3,074
  • sloc: cpp: 26,886; ansic: 693; sh: 210; makefile: 99; perl: 67
file content (185 lines) | stat: -rw-r--r-- 4,978 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
 * Modification History
 *
 * 2004-June-11   Jason Rohrer
 * Created.
 *
 * 2004-June-16   Jason Rohrer
 * Added fuctions for modifying object position, rotation, and transparency.
 *
 * 2004-June-18   Jason Rohrer
 * Changed to use triangles instead of polygons.
 *
 * 2004-June-20   Jason Rohrer
 * Added fuction for modifying scale.
 * Added function for testing circle containment.
 *
 * 2004-June-21   Jason Rohrer
 * Added fuction for getting minimum border distance.
 */



#ifndef DRAWABLE_OBJECT_INCLUDED
#define DRAWABLE_OBJECT_INCLUDED



#include "minorGems/math/geometry/Vector3D.h"
#include "minorGems/math/geometry/Angle3D.h"
#include "minorGems/graphics/Color.h"



/**
 * A 2d object that can draw itself into the current OpenGL context.
 *
 * @author Jason Rohrer.
 */
class DrawableObject {


    public:


        
        /**
         * Constructs an object.
         *
         * @param inNumTriangleVertices the number of triangle vertices.
         *   Must be a multiple of 3.
         * @param inTriangleVertices the triangle vertices.
         *   Only the x and y components have an effect.  This array and
         *   the vertices it contains will be destroyed when this class is
         *   destroyed.
         * @param inTriangleVertexFillColors a fill color for each triangle
         *   vertex.
         *   This array and the colors it contains will be destroyed when
         *   this class is destroyed.
         * @param inNumBorderVertices the number of border vertices.
         * @param inBorderVertices the borer vertices.
         *   Only the x and y components have an effect.  This array and
         *   the vertices it contains will be destroyed when this class is
         *   destroyed.
         * @param inVertextBorderColors a border color for each vertex.
         *   This array and the colors it contains will be destroyed when
         *   this class is destroyed.
         * @param inBorderWidth the width of the border, in pixels.
         */
        DrawableObject( int inNumTriangleVertices,
                        Vector3D **inTriangleVertices,
                        Color **inTriangleVertexFillColors,
                        int inNumBorderVertices,
                        Vector3D **inBorderVertices,
                        Color **inBorderVertextColors,
                        float inBorderWidth );

        

        virtual ~DrawableObject();


        
        /**
         * Rotates this object.
         *
         * @param inRotation the angle to rotate it by.
         *   Must be destroyed by caller.
         */
        void rotate( Angle3D *inRotation );


        
        /**
         * Moves this object.
         *
         * @param inPosition the vector to move it by.
         *   Must be destroyed by caller.
         */
        void move( Vector3D *inPosition );



        /**
         * Scales this object.
         *
         * @param inScale the multiplier to scale it by.
         */
        void scale( double inScale );


        
        /**
         * Fades the colors of this object (makes them more transparent).
         *
         * @param inAlphaScale the value, in the range [0,1] to multiply
         *   alpha values by.
         */
        void fade( double inAlphaScale );


        
        /**
         * Tests whether any of this object's border vertices are in a circle.
         *
         * @param inCenter the center of the circle.
         *   Must be destroyed by caller.
         * @param inRadius the radius of the circle.
         */
        char isBorderInCircle( Vector3D *inCenter, double inRadius );


        
        /**
         * Gets the maximum distance of the border vertices from a given
         * point.
         *
         * @param inPoint the point to get the distance from.
         *   Must be destroyed by caller.
         */
        double getBorderMaxDistance( Vector3D *inPoint );



        /**
         * Gets the minimum distance of the border vertices from a given
         * point.
         *
         * @param inPoint the point to get the distance from.
         *   Must be destroyed by caller.
         */
        double getBorderMinDistance( Vector3D *inPoint );

        
        
        /**
         * Draws this object into the current OpenGL context.
         *
         * @param inScale the scale factor.
         * @param inRotation the rotation of the object.
         *   Must be destroyed by caller.
         * @param inPosition the position of the object.
         *   Must be destroyed by caller.
         */
        void draw( double inScale, Angle3D *inRotation, Vector3D *inPosition );

        
        
    protected:
        int mNumTriangleVertices;
        Vector3D **mTriangleVertices;
        Color **mTriangleVertexFillColors;

        int mNumBorderVertices;
        Vector3D **mBorderVertices;
        Color **mBorderVertexColors;

        float mBorderWidth;

        
        
    };



#endif