Irrlicht 3D Engine
 
Loading...
Searching...
No Matches
IAttributes.h
Go to the documentation of this file.
1// Copyright (C) 2002-2012 Nikolaus Gebhardt
2// This file is part of the "Irrlicht Engine".
3// For conditions of distribution and use, see copyright notice in irrlicht.h
4
5#ifndef __I_ATTRIBUTES_H_INCLUDED__
6#define __I_ATTRIBUTES_H_INCLUDED__
7
8#include "IReferenceCounted.h"
9#include "SColor.h"
10#include "vector3d.h"
11#include "vector2d.h"
12#include "line2d.h"
13#include "line3d.h"
14#include "triangle3d.h"
15#include "position2d.h"
16#include "rect.h"
17#include "dimension2d.h"
18#include "matrix4.h"
19#include "quaternion.h"
20#include "plane3d.h"
21#include "triangle3d.h"
22#include "line2d.h"
23#include "line3d.h"
24#include "irrString.h"
25#include "irrArray.h"
26#include "IXMLReader.h"
27#include "EAttributes.h"
28#include "path.h"
29
30namespace irr
31{
32namespace video
33{
34 class ITexture;
35} // end namespace video
36namespace io
37{
38 class IXMLWriter;
39
41class IAttributes : public virtual IReferenceCounted
42{
43public:
44
46 virtual u32 getAttributeCount() const = 0;
47
50 virtual const c8* getAttributeName(s32 index) = 0;
51
54 virtual E_ATTRIBUTE_TYPE getAttributeType(const c8* attributeName) = 0;
55
58 virtual E_ATTRIBUTE_TYPE getAttributeType(s32 index) = 0;
59
62 virtual const wchar_t* getAttributeTypeString(const c8* attributeName) = 0;
63
66 virtual const wchar_t* getAttributeTypeString(s32 index) = 0;
67
69 virtual bool existsAttribute(const c8* attributeName) = 0;
70
72 virtual s32 findAttribute(const c8* attributeName) const =0;
73
75 virtual void clear() = 0;
76
83 virtual bool read(io::IXMLReader* reader, bool readCurrentElementOnly=false, const wchar_t* elementName=0) = 0;
84
89 virtual bool write(io::IXMLWriter* writer, bool writeXMLHeader=false, const wchar_t* elementName=0) = 0;
90
91
92 /*
93
94 Integer Attribute
95
96 */
97
99 virtual void addInt(const c8* attributeName, s32 value) = 0;
100
102 virtual void setAttribute(const c8* attributeName, s32 value) = 0;
103
107 virtual s32 getAttributeAsInt(const c8* attributeName) const =0;
108
111 virtual s32 getAttributeAsInt(s32 index) const =0;
112
114 virtual void setAttribute(s32 index, s32 value) = 0;
115
116 /*
117
118 Float Attribute
119
120 */
121
123 virtual void addFloat(const c8* attributeName, f32 value) = 0;
124
126 virtual void setAttribute(const c8* attributeName, f32 value) = 0;
127
131 virtual f32 getAttributeAsFloat(const c8* attributeName) = 0;
132
135 virtual f32 getAttributeAsFloat(s32 index) = 0;
136
138 virtual void setAttribute(s32 index, f32 value) = 0;
139
140 /*
141
142 String Attribute
143
144 */
145
147 virtual void addString(const c8* attributeName, const c8* value) = 0;
148
152 virtual void setAttribute(const c8* attributeName, const c8* value) = 0;
153
158 virtual core::stringc getAttributeAsString(const c8* attributeName) = 0;
159
163 virtual void getAttributeAsString(const c8* attributeName, c8* target) = 0;
164
167 virtual core::stringc getAttributeAsString(s32 index) = 0;
168
172 virtual void setAttribute(s32 index, const c8* value) = 0;
173
174 // wide strings
175
177 virtual void addString(const c8* attributeName, const wchar_t* value) = 0;
178
182 virtual void setAttribute(const c8* attributeName, const wchar_t* value) = 0;
183
188 virtual core::stringw getAttributeAsStringW(const c8* attributeName) = 0;
189
193 virtual void getAttributeAsStringW(const c8* attributeName, wchar_t* target) = 0;
194
197 virtual core::stringw getAttributeAsStringW(s32 index) = 0;
198
202 virtual void setAttribute(s32 index, const wchar_t* value) = 0;
203
204 /*
205
206 Binary Data Attribute
207
208 */
209
211 virtual void addBinary(const c8* attributeName, void* data, s32 dataSizeInBytes) = 0;
212
214 virtual void setAttribute(const c8* attributeName, void* data, s32 dataSizeInBytes ) = 0;
215
217
221 virtual void getAttributeAsBinaryData(const c8* attributeName, void* outData, s32 maxSizeInBytes) = 0;
222
224
228 virtual void getAttributeAsBinaryData(s32 index, void* outData, s32 maxSizeInBytes) = 0;
229
231 virtual void setAttribute(s32 index, void* data, s32 dataSizeInBytes ) = 0;
232
233
234 /*
235 Array Attribute
236 */
237
239 virtual void addArray(const c8* attributeName, const core::array<core::stringw>& value) = 0;
240
244 virtual void setAttribute(const c8* attributeName, const core::array<core::stringw>& value) = 0;
245
250 virtual core::array<core::stringw> getAttributeAsArray(const c8* attributeName) = 0;
251
254 virtual core::array<core::stringw> getAttributeAsArray(s32 index) = 0;
255
257 virtual void setAttribute(s32 index, const core::array<core::stringw>& value) = 0;
258
259
260 /*
261
262 Bool Attribute
263
264 */
265
267 virtual void addBool(const c8* attributeName, bool value) = 0;
268
270 virtual void setAttribute(const c8* attributeName, bool value) = 0;
271
275 virtual bool getAttributeAsBool(const c8* attributeName) = 0;
276
279 virtual bool getAttributeAsBool(s32 index) = 0;
280
282 virtual void setAttribute(s32 index, bool value) = 0;
283
284 /*
285
286 Enumeration Attribute
287
288 */
289
291 virtual void addEnum(const c8* attributeName, const c8* enumValue, const c8* const* enumerationLiterals) = 0;
292
294 virtual void addEnum(const c8* attributeName, s32 enumValue, const c8* const* enumerationLiterals) = 0;
295
297 virtual void setAttribute(const c8* attributeName, const c8* enumValue, const c8* const* enumerationLiterals) = 0;
298
302 virtual const c8* getAttributeAsEnumeration(const c8* attributeName) = 0;
303
305
312 virtual s32 getAttributeAsEnumeration(const c8* attributeName, const c8* const* enumerationLiteralsToUse) = 0;
313
315
322 virtual s32 getAttributeAsEnumeration(s32 index, const c8* const* enumerationLiteralsToUse) = 0;
323
326 virtual const c8* getAttributeAsEnumeration(s32 index) = 0;
327
331 virtual void getAttributeEnumerationLiteralsOfEnumeration(const c8* attributeName, core::array<core::stringc>& outLiterals) = 0;
332
336 virtual void getAttributeEnumerationLiteralsOfEnumeration(s32 index, core::array<core::stringc>& outLiterals) = 0;
337
339 virtual void setAttribute(s32 index, const c8* enumValue, const c8* const* enumerationLiterals) = 0;
340
341
342 /*
343
344 SColor Attribute
345
346 */
347
349 virtual void addColor(const c8* attributeName, video::SColor value) = 0;
350
351
353 virtual void setAttribute(const c8* attributeName, video::SColor color) = 0;
354
358 virtual video::SColor getAttributeAsColor(const c8* attributeName) = 0;
359
362 virtual video::SColor getAttributeAsColor(s32 index) = 0;
363
365 virtual void setAttribute(s32 index, video::SColor color) = 0;
366
367 /*
368
369 SColorf Attribute
370
371 */
372
374 virtual void addColorf(const c8* attributeName, video::SColorf value) = 0;
375
377 virtual void setAttribute(const c8* attributeName, video::SColorf color) = 0;
378
382 virtual video::SColorf getAttributeAsColorf(const c8* attributeName) = 0;
383
386 virtual video::SColorf getAttributeAsColorf(s32 index) = 0;
387
389 virtual void setAttribute(s32 index, video::SColorf color) = 0;
390
391
392 /*
393
394 Vector3d Attribute
395
396 */
397
399 virtual void addVector3d(const c8* attributeName, core::vector3df value) = 0;
400
402 virtual void setAttribute(const c8* attributeName, core::vector3df v) = 0;
403
407 virtual core::vector3df getAttributeAsVector3d(const c8* attributeName) = 0;
408
411 virtual core::vector3df getAttributeAsVector3d(s32 index) = 0;
412
414 virtual void setAttribute(s32 index, core::vector3df v) = 0;
415
416 /*
417
418 Vector2d Attribute
419
420 */
421
423 virtual void addVector2d(const c8* attributeName, core::vector2df value) = 0;
424
426 virtual void setAttribute(const c8* attributeName, core::vector2df v) = 0;
427
431 virtual core::vector2df getAttributeAsVector2d(const c8* attributeName) = 0;
432
435 virtual core::vector2df getAttributeAsVector2d(s32 index) = 0;
436
438 virtual void setAttribute(s32 index, core::vector2df v) = 0;
439
440 /*
441
442 Position2d Attribute
443
444 */
445
447 virtual void addPosition2d(const c8* attributeName, core::position2di value) = 0;
448
450 virtual void setAttribute(const c8* attributeName, core::position2di v) = 0;
451
455 virtual core::position2di getAttributeAsPosition2d(const c8* attributeName) = 0;
456
459 virtual core::position2di getAttributeAsPosition2d(s32 index) = 0;
460
462 virtual void setAttribute(s32 index, core::position2di v) = 0;
463
464 /*
465
466 Rectangle Attribute
467
468 */
469
471 virtual void addRect(const c8* attributeName, core::rect<s32> value) = 0;
472
474 virtual void setAttribute(const c8* attributeName, core::rect<s32> v) = 0;
475
479 virtual core::rect<s32> getAttributeAsRect(const c8* attributeName) = 0;
480
483 virtual core::rect<s32> getAttributeAsRect(s32 index) = 0;
484
486 virtual void setAttribute(s32 index, core::rect<s32> v) = 0;
487
488
489 /*
490
491 Dimension2d Attribute
492
493 */
494
496 virtual void addDimension2d(const c8* attributeName, core::dimension2d<u32> value) = 0;
497
499 virtual void setAttribute(const c8* attributeName, core::dimension2d<u32> v) = 0;
500
504 virtual core::dimension2d<u32> getAttributeAsDimension2d(const c8* attributeName) = 0;
505
508 virtual core::dimension2d<u32> getAttributeAsDimension2d(s32 index) = 0;
509
511 virtual void setAttribute(s32 index, core::dimension2d<u32> v) = 0;
512
513
514 /*
515 matrix attribute
516 */
517
519 virtual void addMatrix(const c8* attributeName, const core::matrix4& v) = 0;
520
522 virtual void setAttribute(const c8* attributeName, const core::matrix4& v) = 0;
523
527 virtual core::matrix4 getAttributeAsMatrix(const c8* attributeName) = 0;
528
531 virtual core::matrix4 getAttributeAsMatrix(s32 index) = 0;
532