Skip to content

Commit 0b52dc1

Browse files
committed
add documentation for mcEnqueueDispatchPlanarSection
1 parent 3261a07 commit 0b52dc1

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

include/mcut/mcut.h

+9
Original file line numberDiff line numberDiff line change
@@ -1019,6 +1019,15 @@ extern MCAPI_ATTR McResult MCAPI_CALL mcDispatch(
10191019
uint32_t numCutMeshVertices,
10201020
uint32_t numCutMeshFaces);
10211021

1022+
/**
1023+
* @brief This function behaves similerly to ::mcEnqueueDispatch except that only one input mesh is provided by the user
1024+
* together with two other parameters that specify a plane. This plane is used to slice the given mesh completely.
1025+
*
1026+
* @param[in] pNormalVector A non-zero vector the specifies the normal of the slicing plane.
1027+
* @param[in] sectionOffset A value between zero and one, which specifies the relative position of the plane along, where this position is constrained to be along the a line segment whose direction is the same as that of the given normal vector.
1028+
A value of zero corresponds to the start point of the line segment, which is the position of the mesh vertex whose projection-onto/dot-product-with the given normal is closest to negative infinity.
1029+
A value of one corresponds to the end point of the line segment, which is the position of the mesh vertex whose projection-onto/dot-product-with the given normal is closest to positive infinity.
1030+
*/
10221031
extern MCAPI_ATTR McResult MCAPI_CALL mcEnqueueDispatchPlanarSection(
10231032
const McContext context,
10241033
McFlags dispatchFlags,

0 commit comments

Comments
 (0)