summaryrefslogtreecommitdiff
path: root/include/IAttributeExchangingObject.h
diff options
context:
space:
mode:
authorMirrorbot <mirrorbot@cogarr.net>2025-12-27 17:53:06 -0600
committerMirrorbot <mirrorbot@cogarr.net>2025-12-27 17:53:06 -0600
commit71e94ee161447b84c0eaabf6567f8fa62262cd3e (patch)
tree391064cc6173a6fe75069af2fdc1978af12f623e /include/IAttributeExchangingObject.h
downloadirrlicht-71e94ee161447b84c0eaabf6567f8fa62262cd3e.tar.gz
irrlicht-71e94ee161447b84c0eaabf6567f8fa62262cd3e.tar.bz2
irrlicht-71e94ee161447b84c0eaabf6567f8fa62262cd3e.zip
Inital commitHEADmaster
Diffstat (limited to 'include/IAttributeExchangingObject.h')
-rw-r--r--include/IAttributeExchangingObject.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/include/IAttributeExchangingObject.h b/include/IAttributeExchangingObject.h
new file mode 100644
index 0000000..5b13cdb
--- /dev/null
+++ b/include/IAttributeExchangingObject.h
@@ -0,0 +1,71 @@
+// Copyright (C) 2002-2012 Nikolaus Gebhardt
+// This file is part of the "Irrlicht Engine".
+// For conditions of distribution and use, see copyright notice in irrlicht.h
+
+#ifndef __I_ATTRIBUTE_EXCHANGING_OBJECT_H_INCLUDED__
+#define __I_ATTRIBUTE_EXCHANGING_OBJECT_H_INCLUDED__
+
+#include "IReferenceCounted.h"
+
+
+namespace irr
+{
+
+namespace io
+{
+
+class IAttributes;
+
+//! Enumeration flags passed through SAttributeReadWriteOptions to the IAttributeExchangingObject object
+enum E_ATTRIBUTE_READ_WRITE_FLAGS
+{
+ //! Serialization/Deserializion is done for an xml file
+ EARWF_FOR_FILE = 0x00000001,
+
+ //! Serialization/Deserializion is done for an editor property box
+ EARWF_FOR_EDITOR = 0x00000002,
+
+ //! When writing filenames, relative paths should be used
+ EARWF_USE_RELATIVE_PATHS = 0x00000004
+};
+
+
+//! struct holding data describing options
+struct SAttributeReadWriteOptions
+{
+ //! Constructor
+ SAttributeReadWriteOptions()
+ : Flags(0), Filename(0)
+ {
+ }
+
+ //! Combination of E_ATTRIBUTE_READ_WRITE_FLAGS or other, custom ones
+ s32 Flags;
+
+ //! Optional filename
+ const fschar_t* Filename;
+};
+
+
+//! An object which is able to serialize and deserialize its attributes into an attributes object
+class IAttributeExchangingObject : virtual public IReferenceCounted
+{
+public:
+
+ //! Writes attributes of the object.
+ /** Implement this to expose the attributes of your scene node animator for
+ scripting languages, editors, debuggers or xml serialization purposes. */
+ virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options=0) const {}
+
+ //! Reads attributes of the object.
+ /** Implement this to set the attributes of your scene node animator for
+ scripting languages, editors, debuggers or xml deserialization purposes. */
+ virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options=0) {}
+
+};
+
+} // end namespace io
+} // end namespace irr
+
+#endif
+