Skip to content

Commit

Permalink
Fixed typos in description of API
Browse files Browse the repository at this point in the history
  • Loading branch information
@netfabb
netfabb committed Sep 26, 2024
1 parent 45d8603 commit c93be5a
Show file tree
Hide file tree
Showing 15 changed files with 94 additions and 94 deletions.
8 changes: 4 additions & 4 deletions Autogenerated/Bindings/C/lib3mf.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3407,12 +3407,12 @@ LIB3MF_DECLSPEC Lib3MFResult lib3mf_toolpathlayerreader_getsegmenthatchdatainmod
*
* @param[in] pToolpathLayerReader - ToolpathLayerReader instance.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[in] nPointDataBufferSize - Number of elements in buffer
* @param[out] pPointDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pPointDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @param[in] nHatchDataBufferSize - Number of elements in buffer
* @param[out] pHatchDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pHatchDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC Lib3MFResult lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nPointDataBufferSize, Lib3MF_uint64* pPointDataNeededCount, sLib3MFDiscreteHatch2D * pPointDataBuffer);
LIB3MF_DECLSPEC Lib3MFResult lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nHatchDataBufferSize, Lib3MF_uint64* pHatchDataNeededCount, sLib3MFDiscreteHatch2D * pHatchDataBuffer);

/**
* Retrieves a segment attribute Information by Attribute Name. Will fail if Attribute does not exist.
Expand Down
8 changes: 4 additions & 4 deletions Autogenerated/Bindings/CDynamic/lib3mf_dynamic.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3394,12 +3394,12 @@ typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataInModelUnit
*
* @param[in] pToolpathLayerReader - ToolpathLayerReader instance.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[in] nPointDataBufferSize - Number of elements in buffer
* @param[out] pPointDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pPointDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @param[in] nHatchDataBufferSize - Number of elements in buffer
* @param[out] pHatchDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pHatchDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @return error code or 0 (success)
*/
typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataDiscretePtr) (Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nPointDataBufferSize, Lib3MF_uint64* pPointDataNeededCount, sLib3MFDiscreteHatch2D * pPointDataBuffer);
typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataDiscretePtr) (Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nHatchDataBufferSize, Lib3MF_uint64* pHatchDataNeededCount, sLib3MFDiscreteHatch2D * pHatchDataBuffer);

/**
* Retrieves a segment attribute Information by Attribute Name. Will fail if Attribute does not exist.
Expand Down
26 changes: 13 additions & 13 deletions Autogenerated/Bindings/CSharp/Lib3MF.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1363,7 +1363,7 @@ public class Lib3MFWrapper
public unsafe extern static Int32 ToolpathLayerReader_GetSegmentHatchDataInModelUnits (IntPtr Handle, UInt32 AIndex, UInt64 sizeHatchData, out UInt64 neededHatchData, IntPtr dataHatchData);

[DllImport("lib3mf.dll", EntryPoint = "lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete", CallingConvention=CallingConvention.Cdecl)]
public unsafe extern static Int32 ToolpathLayerReader_GetSegmentHatchDataDiscrete (IntPtr Handle, UInt32 AIndex, UInt64 sizePointData, out UInt64 neededPointData, IntPtr dataPointData);
public unsafe extern static Int32 ToolpathLayerReader_GetSegmentHatchDataDiscrete (IntPtr Handle, UInt32 AIndex, UInt64 sizeHatchData, out UInt64 neededHatchData, IntPtr dataHatchData);

[DllImport("lib3mf.dll", EntryPoint = "lib3mf_toolpathlayerreader_findsegmentattributeinfobyname", CallingConvention=CallingConvention.Cdecl)]
public unsafe extern static Int32 ToolpathLayerReader_FindSegmentAttributeInfoByName (IntPtr Handle, byte[] ANameSpace, byte[] AAttributeName, out UInt32 AID, out Int32 AAttributeType);
Expand Down Expand Up @@ -5716,20 +5716,20 @@ public void GetSegmentHatchDataInModelUnits (UInt32 AIndex, out sHatch2D[] AHatc
AHatchData[index] = Internal.Lib3MFWrapper.convertInternalToStruct_Hatch2D(arrayHatchData[index]);
}

public void GetSegmentHatchDataDiscrete (UInt32 AIndex, out sDiscreteHatch2D[] APointData)
public void GetSegmentHatchDataDiscrete (UInt32 AIndex, out sDiscreteHatch2D[] AHatchData)
{
UInt64 sizePointData = 0;
UInt64 neededPointData = 0;
CheckError(Internal.Lib3MFWrapper.ToolpathLayerReader_GetSegmentHatchDataDiscrete (Handle, AIndex, sizePointData, out neededPointData, IntPtr.Zero));
sizePointData = neededPointData;
var arrayPointData = new Internal.InternalDiscreteHatch2D[sizePointData];
GCHandle dataPointData = GCHandle.Alloc(arrayPointData, GCHandleType.Pinned);
UInt64 sizeHatchData = 0;
UInt64 neededHatchData = 0;
CheckError(Internal.Lib3MFWrapper.ToolpathLayerReader_GetSegmentHatchDataDiscrete (Handle, AIndex, sizeHatchData, out neededHatchData, IntPtr.Zero));
sizeHatchData = neededHatchData;
var arrayHatchData = new Internal.InternalDiscreteHatch2D[sizeHatchData];
GCHandle dataHatchData = GCHandle.Alloc(arrayHatchData, GCHandleType.Pinned);

CheckError(Internal.Lib3MFWrapper.ToolpathLayerReader_GetSegmentHatchDataDiscrete (Handle, AIndex, sizePointData, out neededPointData, dataPointData.AddrOfPinnedObject()));
dataPointData.Free();
APointData = new sDiscreteHatch2D[sizePointData];
for (int index = 0; index < APointData.Length; index++)
APointData[index] = Internal.Lib3MFWrapper.convertInternalToStruct_DiscreteHatch2D(arrayPointData[index]);
CheckError(Internal.Lib3MFWrapper.ToolpathLayerReader_GetSegmentHatchDataDiscrete (Handle, AIndex, sizeHatchData, out neededHatchData, dataHatchData.AddrOfPinnedObject()));
dataHatchData.Free();
AHatchData = new sDiscreteHatch2D[sizeHatchData];
for (int index = 0; index < AHatchData.Length; index++)
AHatchData[index] = Internal.Lib3MFWrapper.convertInternalToStruct_DiscreteHatch2D(arrayHatchData[index]);
}

public void FindSegmentAttributeInfoByName (String ANameSpace, String AAttributeName, out UInt32 AID, out eToolpathAttributeType AAttributeType)
Expand Down
8 changes: 4 additions & 4 deletions Autogenerated/Bindings/Cpp/lib3mf_abi.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3407,12 +3407,12 @@ LIB3MF_DECLSPEC Lib3MFResult lib3mf_toolpathlayerreader_getsegmenthatchdatainmod
*
* @param[in] pToolpathLayerReader - ToolpathLayerReader instance.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[in] nPointDataBufferSize - Number of elements in buffer
* @param[out] pPointDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pPointDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @param[in] nHatchDataBufferSize - Number of elements in buffer
* @param[out] pHatchDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pHatchDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC Lib3MFResult lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nPointDataBufferSize, Lib3MF_uint64* pPointDataNeededCount, Lib3MF::sDiscreteHatch2D * pPointDataBuffer);
LIB3MF_DECLSPEC Lib3MFResult lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nHatchDataBufferSize, Lib3MF_uint64* pHatchDataNeededCount, Lib3MF::sDiscreteHatch2D * pHatchDataBuffer);

/**
* Retrieves a segment attribute Information by Attribute Name. Will fail if Attribute does not exist.
Expand Down
16 changes: 8 additions & 8 deletions Autogenerated/Bindings/Cpp/lib3mf_implicit.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1689,7 +1689,7 @@ class CToolpathLayerReader : public CBase {
inline void GetSegmentPointDataInModelUnits(const Lib3MF_uint32 nIndex, std::vector<sPosition2D> & PointDataBuffer);
inline void GetSegmentPointDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscretePosition2D> & PointDataBuffer);
inline void GetSegmentHatchDataInModelUnits(const Lib3MF_uint32 nIndex, std::vector<sHatch2D> & HatchDataBuffer);
inline void GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & PointDataBuffer);
inline void GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & HatchDataBuffer);
inline void FindSegmentAttributeInfoByName(const std::string & sNameSpace, const std::string & sAttributeName, Lib3MF_uint32 & nID, eToolpathAttributeType & eAttributeType);
inline Lib3MF_uint32 FindSegmentAttributeIDByName(const std::string & sNameSpace, const std::string & sAttributeName);
inline eToolpathAttributeType FindSegmentAttributeTypeByName(const std::string & sNameSpace, const std::string & sAttributeName);
Expand Down Expand Up @@ -6540,15 +6540,15 @@ inline CBase* CWrapper::polymorphicFactory(Lib3MFHandle pHandle)
/**
* CToolpathLayerReader::GetSegmentHatchDataDiscrete - Retrieves the assigned segment hatch list in toolpath units. Converts any polyline or loop into hatches. Returns an empty array for delay and sync elements.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[out] PointDataBuffer - The hatch data array. The point coordinates are in toolpath units.
* @param[out] HatchDataBuffer - The hatch data array. The point coordinates are in toolpath units.
*/
void CToolpathLayerReader::GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & PointDataBuffer)
void CToolpathLayerReader::GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & HatchDataBuffer)
{
Lib3MF_uint64 elementsNeededPointData = 0;
Lib3MF_uint64 elementsWrittenPointData = 0;
CheckError(lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(m_pHandle, nIndex, 0, &elementsNeededPointData, nullptr));
PointDataBuffer.resize((size_t) elementsNeededPointData);
CheckError(lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(m_pHandle, nIndex, elementsNeededPointData, &elementsWrittenPointData, PointDataBuffer.data()));
Lib3MF_uint64 elementsNeededHatchData = 0;
Lib3MF_uint64 elementsWrittenHatchData = 0;
CheckError(lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(m_pHandle, nIndex, 0, &elementsNeededHatchData, nullptr));
HatchDataBuffer.resize((size_t) elementsNeededHatchData);
CheckError(lib3mf_toolpathlayerreader_getsegmenthatchdatadiscrete(m_pHandle, nIndex, elementsNeededHatchData, &elementsWrittenHatchData, HatchDataBuffer.data()));
}

/**
Expand Down
8 changes: 4 additions & 4 deletions Autogenerated/Bindings/CppDynamic/lib3mf_dynamic.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3394,12 +3394,12 @@ typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataInModelUnit
*
* @param[in] pToolpathLayerReader - ToolpathLayerReader instance.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[in] nPointDataBufferSize - Number of elements in buffer
* @param[out] pPointDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pPointDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @param[in] nHatchDataBufferSize - Number of elements in buffer
* @param[out] pHatchDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pHatchDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @return error code or 0 (success)
*/
typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataDiscretePtr) (Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nPointDataBufferSize, Lib3MF_uint64* pPointDataNeededCount, Lib3MF::sDiscreteHatch2D * pPointDataBuffer);
typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataDiscretePtr) (Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nHatchDataBufferSize, Lib3MF_uint64* pHatchDataNeededCount, Lib3MF::sDiscreteHatch2D * pHatchDataBuffer);

/**
* Retrieves a segment attribute Information by Attribute Name. Will fail if Attribute does not exist.
Expand Down
16 changes: 8 additions & 8 deletions Autogenerated/Bindings/CppDynamic/lib3mf_dynamic.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1713,7 +1713,7 @@ class CToolpathLayerReader : public CBase {
inline void GetSegmentPointDataInModelUnits(const Lib3MF_uint32 nIndex, std::vector<sPosition2D> & PointDataBuffer);
inline void GetSegmentPointDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscretePosition2D> & PointDataBuffer);
inline void GetSegmentHatchDataInModelUnits(const Lib3MF_uint32 nIndex, std::vector<sHatch2D> & HatchDataBuffer);
inline void GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & PointDataBuffer);
inline void GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & HatchDataBuffer);
inline void FindSegmentAttributeInfoByName(const std::string & sNameSpace, const std::string & sAttributeName, Lib3MF_uint32 & nID, eToolpathAttributeType & eAttributeType);
inline Lib3MF_uint32 FindSegmentAttributeIDByName(const std::string & sNameSpace, const std::string & sAttributeName);
inline eToolpathAttributeType FindSegmentAttributeTypeByName(const std::string & sNameSpace, const std::string & sAttributeName);
Expand Down Expand Up @@ -13934,15 +13934,15 @@ inline CBase* CWrapper::polymorphicFactory(Lib3MFHandle pHandle)
/**
* CToolpathLayerReader::GetSegmentHatchDataDiscrete - Retrieves the assigned segment hatch list in toolpath units. Converts any polyline or loop into hatches. Returns an empty array for delay and sync elements.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[out] PointDataBuffer - The hatch data array. The point coordinates are in toolpath units.
* @param[out] HatchDataBuffer - The hatch data array. The point coordinates are in toolpath units.
*/
void CToolpathLayerReader::GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & PointDataBuffer)
void CToolpathLayerReader::GetSegmentHatchDataDiscrete(const Lib3MF_uint32 nIndex, std::vector<sDiscreteHatch2D> & HatchDataBuffer)
{
Lib3MF_uint64 elementsNeededPointData = 0;
Lib3MF_uint64 elementsWrittenPointData = 0;
CheckError(m_pWrapper->m_WrapperTable.m_ToolpathLayerReader_GetSegmentHatchDataDiscrete(m_pHandle, nIndex, 0, &elementsNeededPointData, nullptr));
PointDataBuffer.resize((size_t) elementsNeededPointData);
CheckError(m_pWrapper->m_WrapperTable.m_ToolpathLayerReader_GetSegmentHatchDataDiscrete(m_pHandle, nIndex, elementsNeededPointData, &elementsWrittenPointData, PointDataBuffer.data()));
Lib3MF_uint64 elementsNeededHatchData = 0;
Lib3MF_uint64 elementsWrittenHatchData = 0;
CheckError(m_pWrapper->m_WrapperTable.m_ToolpathLayerReader_GetSegmentHatchDataDiscrete(m_pHandle, nIndex, 0, &elementsNeededHatchData, nullptr));
HatchDataBuffer.resize((size_t) elementsNeededHatchData);
CheckError(m_pWrapper->m_WrapperTable.m_ToolpathLayerReader_GetSegmentHatchDataDiscrete(m_pHandle, nIndex, elementsNeededHatchData, &elementsWrittenHatchData, HatchDataBuffer.data()));
}

/**
Expand Down
18 changes: 9 additions & 9 deletions Autogenerated/Bindings/Go/lib3mf.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Autogenerated/Bindings/Go/lib3mf_dynamic.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3394,12 +3394,12 @@ typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataInModelUnit
*
* @param[in] pToolpathLayerReader - ToolpathLayerReader instance.
* @param[in] nIndex - Index. Must be between 0 and Count - 1.
* @param[in] nPointDataBufferSize - Number of elements in buffer
* @param[out] pPointDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pPointDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @param[in] nHatchDataBufferSize - Number of elements in buffer
* @param[out] pHatchDataNeededCount - will be filled with the count of the written elements, or needed buffer size.
* @param[out] pHatchDataBuffer - DiscreteHatch2D buffer of The hatch data array. The point coordinates are in toolpath units.
* @return error code or 0 (success)
*/
typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataDiscretePtr) (Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nPointDataBufferSize, Lib3MF_uint64* pPointDataNeededCount, sLib3MFDiscreteHatch2D * pPointDataBuffer);
typedef Lib3MFResult (*PLib3MFToolpathLayerReader_GetSegmentHatchDataDiscretePtr) (Lib3MF_ToolpathLayerReader pToolpathLayerReader, Lib3MF_uint32 nIndex, const Lib3MF_uint64 nHatchDataBufferSize, Lib3MF_uint64* pHatchDataNeededCount, sLib3MFDiscreteHatch2D * pHatchDataBuffer);

/**
* Retrieves a segment attribute Information by Attribute Name. Will fail if Attribute does not exist.
Expand Down
Loading

0 comments on commit c93be5a

Please sign in to comment.