Update documentation

3MFConsortium · Jun 24, 2019 · baf9c57 · baf9c57
1 parent 33feec5
commit baf9c57
Show file tree

Hide file tree

Showing 15 changed files with 90 additions and 89 deletions.
diff --git a/AutomaticComponentToolkit/bin/act.darwin b/AutomaticComponentToolkit/bin/act.darwin
diff --git a/AutomaticComponentToolkit/bin/act.exe b/AutomaticComponentToolkit/bin/act.exe
diff --git a/AutomaticComponentToolkit/bin/act.linux b/AutomaticComponentToolkit/bin/act.linux
diff --git a/Documentation/source/Cpp/CMakeLists_dynamic.txt b/Documentation/source/Cpp/CMakeLists_dynamic.txt
@@ -1,9 +1,10 @@
 cmake_minimum_required(VERSION 3.5)
 
+set(CMAKE_CURRENT_BINDING_DIR ${CMAKE_CURRENT_SOURCE_DIR}/.)
 project(Lib3MFExample_CPPDynamic)
 set(CMAKE_CXX_STANDARD 11)
 add_executable(Lib3MFExample_CPPDynamic "${CMAKE_CURRENT_SOURCE_DIR}/Lib3MF_example.cpp")
 if (UNIX)
 	target_link_libraries(Lib3MFExample_CPPDynamic ${CMAKE_DL_LIBS})
 endif (UNIX)
-target_include_directories(Lib3MFExample_CPPDynamic PRIVATE "D:/PUBLIC/tmp/Lib3MF_component/Documentations/Cpp")
+target_include_directories(Lib3MFExample_CPPDynamic PRIVATE "${CMAKE_CURRENT_BINDING_DIR}")
diff --git a/Documentation/source/Cpp/CMakeLists_explicit.txt b/Documentation/source/Cpp/CMakeLists_explicit.txt
diff --git a/Documentation/source/Cpp/CMakeLists_implicit.txt b/Documentation/source/Cpp/CMakeLists_implicit.txt
@@ -1,8 +1,9 @@
 cmake_minimum_required(VERSION 3.5)
 
+set(CMAKE_CURRENT_BINDING_DIR ${CMAKE_CURRENT_SOURCE_DIR}/.)
 project(Lib3MFExample_CPPImplicit)
 set(CMAKE_CXX_STANDARD 11)
 add_executable(Lib3MFExample_CPPImplicit "${CMAKE_CURRENT_SOURCE_DIR}/Lib3MF_example.cpp")
-find_library(LIB3MFLOCATION lib3mf "D:/PUBLIC/tmp/Lib3MF_component/Documentations/Cpp/../../Implementations/*/*/*")
+find_library(LIB3MFLOCATION lib3mf "D:/PUBLIC/lib3mf_public/AutomaticComponentToolkit/bin/Lib3MF_component/Documentations/Cpp/../../Implementations/*/*/*")
 target_link_libraries(Lib3MFExample_CPPImplicit ${LIB3MFLOCATION})
-target_include_directories(Lib3MFExample_CPPImplicit PRIVATE "D:/PUBLIC/tmp/Lib3MF_component/Documentations/Cpp")
+target_include_directories(Lib3MFExample_CPPImplicit PRIVATE "${CMAKE_CURRENT_BINDING_DIR}")
diff --git a/Documentation/source/Cpp/Lib3MF_example_explicit.cpp b/Documentation/source/Cpp/Lib3MF_example_explicit.cpp
diff --git a/Documentation/source/Cpp/Lib3MFexample_dynamic.cpp b/Documentation/source/Cpp/Lib3MFexample_dynamic.cpp
diff --git a/Documentation/source/Cpp/lib3mf-types.rst b/Documentation/source/Cpp/lib3mf-types.rst
@@ -109,16 +109,18 @@ Enumerations
 		.. cpp:enumerator:: READMESH = 8
 		.. cpp:enumerator:: READSLICES = 9
 		.. cpp:enumerator:: READBUILD = 10
-		.. cpp:enumerator:: CREATEOPCPACKAGE = 11
-		.. cpp:enumerator:: WRITEMODELSTOSTREAM = 12
-		.. cpp:enumerator:: WRITEROOTMODEL = 13
-		.. cpp:enumerator:: WRITENONROOTMODELS = 14
-		.. cpp:enumerator:: WRITEATTACHMENTS = 15
-		.. cpp:enumerator:: WRITECONTENTTYPES = 16
-		.. cpp:enumerator:: WRITENOBJECTS = 17
-		.. cpp:enumerator:: WRITENODES = 18
-		.. cpp:enumerator:: WRITETRIANGLES = 19
-		.. cpp:enumerator:: WRITESLICES = 20
+		.. cpp:enumerator:: READCUSTOMATTACHMENT = 11
+		.. cpp:enumerator:: READTEXTURETACHMENTS = 12
+		.. cpp:enumerator:: CREATEOPCPACKAGE = 13
+		.. cpp:enumerator:: WRITEMODELSTOSTREAM = 14
+		.. cpp:enumerator:: WRITEROOTMODEL = 15
+		.. cpp:enumerator:: WRITENONROOTMODELS = 16
+		.. cpp:enumerator:: WRITEATTACHMENTS = 17
+		.. cpp:enumerator:: WRITECONTENTTYPES = 18
+		.. cpp:enumerator:: WRITENOBJECTS = 19
+		.. cpp:enumerator:: WRITENODES = 20
+		.. cpp:enumerator:: WRITETRIANGLES = 21
+		.. cpp:enumerator:: WRITESLICES = 22
 	
 	.. cpp:enum-class:: eBlendMethod : Lib3MF_int32
 	

diff --git a/Documentation/source/Cpp/lib3mf.rst b/Documentation/source/Cpp/lib3mf.rst
@@ -55,9 +55,16 @@ The wrapper class CWrapper
 
 	.. cpp:function:: void Release(CBase * pInstance)
 	
-		releases an object instance
+		releases shared ownership of an object instance
 
-		:param pInstance: releases the memory of the passed object. 
+		:param pInstance: the object instance to release 
+
+
+	.. cpp:function:: void Acquire(CBase * pInstance)
+	
+		acquires shared ownership of an object instance
+
+		:param pInstance: the object instance to acquire 
 
 
 	.. cpp:function:: void SetJournal(const std::string & sJournalPath)
@@ -76,11 +83,11 @@ The wrapper class CWrapper
 		:returns: Returns if the instance has a last error.
 
 
-	.. cpp:function:: void RetrieveProgressMessage(const eProgressIdentifier eProrgessIdentifier, std::string & sProgressMessage)
+	.. cpp:function:: void RetrieveProgressMessage(const eProgressIdentifier eTheProgressIdentifier, std::string & sProgressMessage)
 	
 		Return an English text for a progress identifier.|Note: this is the only function you can call from your callback function.
 
-		:param eProrgessIdentifier: the progress identifier that is passed to the callback function 
+		:param eTheProgressIdentifier: the progress identifier that is passed to the callback function 
 		:param sProgressMessage: English text for the progress identifier 
 
 

diff --git a/Documentation/source/Cpp/lib3mf_BuildItemIterator.rst b/Documentation/source/Cpp/lib3mf_BuildItemIterator.rst
@@ -38,6 +38,13 @@ CBuildItemIterator
 		:returns: returns the cloned Iterator instance
 
 
+	.. cpp:function:: Lib3MF_uint64 Count()
+
+		Returns the number of build items the iterator captures.
+
+		:returns: returns the number of build items the iterator captures.
+
+
 .. cpp:type:: std::shared_ptr<CBuildItemIterator> Lib3MF::PBuildItemIterator
 
 	Shared pointer to CBuildItemIterator to easily allow reference counting.

diff --git a/Documentation/source/Cpp/lib3mf_MeshObject.rst b/Documentation/source/Cpp/lib3mf_MeshObject.rst
@@ -86,6 +86,23 @@ CMeshObject
 		:param IndicesBuffer: contains the triangle indices. 
 
 
+	.. cpp:function:: void SetObjectLevelProperty(const Lib3MF_uint32 nResourceID, const Lib3MF_uint32 nPropertyID)
+
+		Sets the property at the object-level of the mesh object.
+
+		:param nResourceID: the object-level Property Resource ID. 
+		:param nPropertyID: the object-level PropertyID. 
+
+
+	.. cpp:function:: bool GetObjectLevelProperty(Lib3MF_uint32 & nResourceID, Lib3MF_uint32 & nPropertyID)
+
+		Gets the property at the object-level of the mesh object.
+
+		:param nResourceID: the object-level Property Resource ID. 
+		:param nPropertyID: the object-level PropertyID. 
+		:returns: Has an object-level property been specified?
+
+
 	.. cpp:function:: void SetTriangleProperties(const Lib3MF_uint32 nIndex, const sTriangleProperties & Properties)
 
 		Sets the properties of a single triangle of a mesh object.
@@ -104,7 +121,7 @@ CMeshObject
 
 	.. cpp:function:: void SetAllTriangleProperties(const CInputVector<sTriangleProperties> & PropertiesArrayBuffer)
 
-		Sets the properties of all triangles of a mesh object.
+		Sets the properties of all triangles of a mesh object. Sets the object level property to the first entry of the passed triangle properties, if not yet specified.
 
 		:param PropertiesArrayBuffer: contains the triangle properties array. Must have trianglecount elements. 
 
@@ -116,6 +133,12 @@ CMeshObject
 		:param PropertiesArrayBuffer: returns the triangle properties array. Must have trianglecount elements. 
 
 
+	.. cpp:function:: void ClearAllProperties()
+
+		Clears all properties of this mesh object (triangle and object-level).
+
+
+
 	.. cpp:function:: void SetGeometry(const CInputVector<sPosition> & VerticesBuffer, const CInputVector<sTriangle> & IndicesBuffer)
 
 		Set all triangles of a mesh object

diff --git a/Documentation/source/Cpp/lib3mf_MeshObjectIterator.rst b/Documentation/source/Cpp/lib3mf_MeshObjectIterator.rst
@@ -0,0 +1,23 @@
+
+CMeshObjectIterator
+====================================================================================================
+
+
+.. cpp:class:: Lib3MF::CMeshObjectIterator : public CResourceIterator 
+
+	
+
+
+
+
+	.. cpp:function:: PMeshObject GetCurrentMeshObject()
+
+		Returns the MeshObject the iterator points at.
+
+		:returns: returns the MeshObject instance.
+
+
+.. cpp:type:: std::shared_ptr<CMeshObjectIterator> Lib3MF::PMeshObjectIterator
+
+	Shared pointer to CMeshObjectIterator to easily allow reference counting.
+
diff --git a/Documentation/source/Cpp/lib3mf_Model.rst b/Documentation/source/Cpp/lib3mf_Model.rst
@@ -170,7 +170,7 @@ CModel
 		:returns: returns the iterator instance.
 
 
-	.. cpp:function:: PResourceIterator GetMeshObjects()
+	.. cpp:function:: PMeshObjectIterator GetMeshObjects()
 
 		creates a resource iterator instance with all mesh object resources.
 

diff --git a/Documentation/source/Cpp/lib3mf_ResourceIterator.rst b/Documentation/source/Cpp/lib3mf_ResourceIterator.rst
@@ -38,6 +38,13 @@ CResourceIterator
 		:returns: returns the cloned Iterator instance
 
 
+	.. cpp:function:: Lib3MF_uint64 Count()
+
+		Returns the number of resoucres the iterator captures.
+
+		:returns: returns the number of resoucres the iterator captures.
+
+
 .. cpp:type:: std::shared_ptr<CResourceIterator> Lib3MF::PResourceIterator
 
 	Shared pointer to CResourceIterator to easily allow reference counting.