Skip to content
This repository was archived by the owner on Jan 18, 2024. It is now read-only.

Commit 2959f15

Browse files
added missing sharedapi/spicapi and remove impl
1 parent 646f74a commit 2959f15

7 files changed

+41
-0
lines changed

Input.hpp

+5
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ namespace spic {
1414

1515
/**
1616
* @brief Some convenient input functions.
17+
* @spicapi
1718
*/
1819
namespace Input {
1920

@@ -338,24 +339,28 @@ namespace spic {
338339
/**
339340
* Register a new key listener
340341
* @param listener A reference to a key listener
342+
* @sharedapi
341343
*/
342344
void RegisterKeyListener(IKeyListener& listener);
343345

344346
/**
345347
* Unregister a key listener
346348
* @param listener A reference to a key listener
349+
* @sharedapi
347350
*/
348351
void UnregisterKeyListener(IKeyListener& listener);
349352

350353
/**
351354
* Register a new mouse listener
352355
* @param listener A reference to a mouse listener
356+
* @sharedapi
353357
*/
354358
void RegisterMouseListener(IMouseListener& listener);
355359

356360
/**
357361
* Unregister a mouse listener
358362
* @param listener A reference to a mouse listener
363+
* @sharedapi
359364
*/
360365
void UnregisterMouseListener(IMouseListener& listener);
361366

RigidBody.hpp

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace spic {
88

99
/**
1010
* @brief Enumeration for different rigid body types
11+
* @spicapi
1112
*/
1213
enum class BodyType {
1314
staticBody,
@@ -17,6 +18,7 @@ namespace spic {
1718

1819
/**
1920
* @brief A component representing a rigid body.
21+
* @spicapi
2022
*/
2123
class RigidBody : public Component {
2224
public:
@@ -25,6 +27,7 @@ namespace spic {
2527
* @param mass The mass of the rigid body
2628
* @param gravityScale The scale of the gravity of the rigid body
2729
* @param bodyType The type of the rigid body
30+
* @sharedapi
2831
*/
2932
RigidBody(double mass, double gravityScale, const BodyType& bodyType);
3033

Scene.hpp

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ namespace spic {
1414

1515
/**
1616
* @brief Class representing a scene which can be rendered by the Camera.
17+
* @spicapi
1718
*/
1819
class Scene {
1920
public:

Sprite.hpp

+14
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ namespace spic {
2020
* @param flipY The flip of the y-axis of the sprite
2121
* @param sortingLayer The layer the sprite will be sorted on
2222
* @param orderLayer The layer the sprite will be ordered on
23+
* @sharedapi
2324
*/
2425
Sprite(const std::string& sprite, bool flipX, bool flipY, int sortingLayer, int orderLayer);
2526

@@ -31,78 +32,91 @@ namespace spic {
3132
* @param flipY The flip of the y-axis of the sprite
3233
* @param sortingLayer The layer the sprite will be sorted on
3334
* @param orderInLayer The layer the sprite will be ordered on
35+
* @sharedapi
3436
*/
3537
Sprite(const std::string& sprite, const Color& color, bool flipX, bool flipY, int sortingLayer, int orderInLayer);
3638

3739
/**
3840
* @brief The texture of the sprite
3941
* @param sprite the path to the sprite
42+
* @sharedapi
4043
*/
4144
void Texture(const std::string& sprite);
4245

4346
/**
4447
* @brief The texture of the sprite
4548
* @return The path of the sprite
49+
* @sharedapi
4650
*/
4751
const std::string& Texture() const;
4852

4953
/**
5054
* @brief The color of the sprite
5155
* @param color the color
56+
* @sharedapi
5257
*/
5358
void Color(const spic::Color& color);
5459

5560
/**
5661
* @brief The color of the sprite
5762
* @return the color
63+
* @sharedapi
5864
*/
5965
const spic::Color& Color() const;
6066

6167
/**
6268
* @brief Whether the sprite should be flipped on the X-axis
6369
* @param flipX desired value
70+
* @sharedapi
6471
*/
6572
void FlipX(bool flipX);
6673

6774
/**
6875
* @brief Whether the sprite should be flipped on the X-axis
6976
* @return current value
77+
* @sharedapi
7078
*/
7179
bool FlipX() const;
7280

7381
/**
7482
* @brief Whether the sprite should be flipped on the Y-axis
7583
* @param flipY desired value
84+
* @sharedapi
7685
*/
7786
void FlipY(bool flipY);
7887

7988
/**
8089
* @brief Whether the sprite should be flipped on the Y-axis
8190
* @return current value
91+
* @sharedapi
8292
*/
8393
bool FlipY() const;
8494

8595
/**
8696
* @brief The layer the sprite will be sorted on
8797
* @param sortingLayer desired value
98+
* @sharedapi
8899
*/
89100
void SortingLayer(int sortingLayer);
90101

91102
/**
92103
* @brief The layer the sprite will be sorted on
93104
* @return current value
105+
* @sharedapi
94106
*/
95107
int SortingLayer() const;
96108

97109
/**
98110
* @brief The layer the sprite will be ordered on
99111
* @param orderInLayer desired value
112+
* @sharedapi
100113
*/
101114
void OrderInLayer(int orderInLayer);
102115

103116
/**
104117
* @brief The layer the sprite will be ordered on
105118
* @return current value
119+
* @sharedapi
106120
*/
107121
int OrderInLayer() const;
108122

Text.hpp

+12
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace spic {
3030
* @param layer The layer for the game object.
3131
* @param width The width of the UI object.
3232
* @param height The height of the UI object.
33+
* @sharedapi
3334
*/
3435
Text(const std::string& name, const std::string& tag, int layer, double width, double height);
3536

@@ -45,66 +46,77 @@ namespace spic {
4546
* @param size The size the font will be rendered at
4647
* @param alignment The alignment the content will be rendered with
4748
* @param color The color the content will be rendered in
49+
* @sharedapi
4850
*/
4951
Text(const std::string& name, const std::string& tag, int layer, double width, double height, const std::string& text, const std::string& font, int size, Alignment alignment, const Color& color);
5052

5153
/**
5254
* @brief Get the content of the Text object
5355
* @return A reference to the content of the Text object
56+
* @sharedapi
5457
*/
5558
const std::string& Content() const;
5659

5760
/**
5861
* @brief Set the text content of the Text object
5962
* @param text new content
63+
* @sharedapi
6064
*/
6165
void Content(const std::string& text);
6266

6367
/**
6468
* @brief Get the font of the Text object
6569
* @return A reference to the font of the Text object
70+
* @sharedapi
6671
*/
6772
const std::string& Font() const;
6873

6974
/**
7075
* @brief Set the font of the Text object
7176
* @param font the new font
77+
* @sharedapi
7278
*/
7379
void Font(const std::string& font);
7480

7581
/**
7682
* @brief Get the size of the Text object
7783
* @return A reference to the size of the Text object
84+
* @sharedapi
7885
*/
7986
int Size() const;
8087

8188
/**
8289
* @brief Set the size of the Text object
8390
* @param size the new size
91+
* @sharedapi
8492
*/
8593
void Size(int size);
8694

8795
/**
8896
* @brief Get the alignment of the Text object
8997
* @return A reference to the alignment of the Text object
98+
* @sharedapi
9099
*/
91100
Alignment TextAlignment() const;
92101

93102
/**
94103
* @brief Set the alignment of the content of the Text object
95104
* @param alignment the new alignment
105+
* @sharedapi
96106
*/
97107
void TextAlignment(Alignment alignment);
98108

99109
/**
100110
* @brief Get the color of the Text object
101111
* @return A reference to the color of the Text object
112+
* @sharedapi
102113
*/
103114
const Color& TextColor() const;
104115

105116
/**
106117
* @brief Set the color of the Text object
107118
* @param color the new color
119+
* @sharedapi
108120
*/
109121
void TextColor(const Color& color);
110122

Time.hpp

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ namespace spic {
55

66
/**
77
* @brief Class representing game time.
8+
* @spicapi
89
*/
910
class Time {
1011
public:

UIObject.hpp

+5
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,35 @@ namespace spic {
2222
* @param layer The layer for the game object.
2323
* @param width The width of the UI object.
2424
* @param height The height of the UI object.
25+
* @sharedapi
2526
*/
2627
UIObject(const std::string& name, const std::string& tag, int layer, double width, double height);
2728

2829
/**
2930
* @brief Get the width of the UIObject
3031
* @return The width of the UIObject
32+
* @sharedapi
3133
*/
3234
double Width() const;
3335

3436
/**
3537
* @brief Set the width of the UIObject
3638
* @param newWidth The new width of the UIObject
39+
* @sharedapi
3740
*/
3841
void Width(double newWidth);
3942

4043
/**
4144
* @brief Get the height of the UIObject
4245
* @return The height of the UIObject
46+
* @sharedapi
4347
*/
4448
double Height() const;
4549

4650
/**
4751
* @brief Set the height of the UIObject
4852
* @param newHeight The new height of the UIObject
53+
* @sharedapi
4954
*/
5055
void Height(double newHeight);
5156

0 commit comments

Comments
 (0)