Class FaceHelper

Helper methods for ICamApiFace

Inheritance

object

FaceHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class FaceHelper

Methods

EnumerateLoops(ComWrapper<ICamApiFace>)

Lists all loops in a face using GetNext(), disposing each wrapper as we go along

Declaration

public static IEnumerable<ComWrapper<ICamApiLoop>> EnumerateLoops(this ComWrapper<ICamApiFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamApiLoop>>

GetCone(ComWrapper<ICamApiFace>, out TST3DPoint, out TST3DPoint, out double, out double)

If the face is conical, return its apex, axis, base radius and half-angle

Declaration

public static bool GetCone(this ComWrapper<ICamApiFace> faceCom, out TST3DPoint center, out TST3DPoint axis, out double radius, out double halfAngle)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom
TST3DPoint	center
TST3DPoint	axis
double	radius
double	halfAngle

Returns

Type	Description
bool

GetCylinder(ComWrapper<ICamApiFace>, out TST3DPoint, out TST3DPoint, out double)

If the face is cylindrical, return its axis and radius

Declaration

public static bool GetCylinder(this ComWrapper<ICamApiFace> faceCom, out TST3DPoint center, out TST3DPoint axis, out double radius)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom
TST3DPoint	center
TST3DPoint	axis
double	radius

Returns

Type	Description
bool

GetFirstLoop(ComWrapper<ICamApiFace>)

Get first loop of the face. Next loops can be obtained via GetNext method of created ICamApiLoop object

Declaration

public static ComWrapper<ICamApiLoop> GetFirstLoop(this ComWrapper<ICamApiFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom

Returns

Type	Description
ComWrapper<ICamApiLoop>

GetMaxCurvatureRadius(ComWrapper<ICamApiFace>, double)

Maximum radius of curvature of the iso-parametric curves sampled over the face. Returns MaxFloat when no finite curved direction was found

Declaration

public static double GetMaxCurvatureRadius(this ComWrapper<ICamApiFace> faceCom, double tol)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom
double	tol

Returns

Type	Description
double

GetMesh(ComWrapper<ICamApiFace>, double)

Declaration

public static ComWrapper<ICamApiMesh> GetMesh(this ComWrapper<ICamApiFace> faceCom, double tol)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom
double	tol

Returns

Type	Description
ComWrapper<ICamApiMesh>

GetMinCurvatureRadius(ComWrapper<ICamApiFace>, double)

Minimum radius of curvature over the face. Returns MaxFloat for a planar face

Declaration

public static double GetMinCurvatureRadius(this ComWrapper<ICamApiFace> faceCom, double tol)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom
double	tol

Returns

Type	Description
double

GetNurbsForm(ComWrapper<ICamApiFace>)

Declaration

public static ComWrapper<ICamApiFace> GetNurbsForm(this ComWrapper<ICamApiFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom

Returns

Type	Description
ComWrapper<ICamApiFace>

GetPlane(ComWrapper<ICamApiFace>, out TST3DPoint, out TST3DPoint)

If the face is planar, return the plane origin and unit normal

Declaration

public static bool GetPlane(this ComWrapper<ICamApiFace> faceCom, out TST3DPoint origin, out TST3DPoint normal)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom
TST3DPoint	origin
TST3DPoint	normal

Returns

Type	Description
bool

IsCylindricalHole(ComWrapper<ICamApiFace>, double, out TST3DPoint, out TST3DPoint, out double, out double, out double)

Check if face is cylindrical hole and return params of this hole

Declaration

public static bool IsCylindricalHole(this ComWrapper<ICamApiFace> faceCom, double tol, out TST3DPoint center, out TST3DPoint axis, out double radius, out double zMin, out double zMax)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom	Face COM wrapper
double	tol	Tolerance for checking
TST3DPoint	center	Center of the hole
TST3DPoint	axis	Direction of the hole axis
double	radius	Radius of the hole
double	zMin	Minimum Z coordinate of the hole
double	zMax	Maximum Z coordinate of the hole

Returns

Type	Description
bool	True if the face is a cylindrical hole, false otherwise

Orientation(ComWrapper<ICamApiFace>)

Declaration

public static bool Orientation(this ComWrapper<ICamApiFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom

Returns

Type	Description
bool

Surface(ComWrapper<ICamApiFace>)

Declaration

public static ComWrapper<ICamApiSurface> Surface(this ComWrapper<ICamApiFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom

Returns

Type	Description
ComWrapper<ICamApiSurface>

SurfaceKind(ComWrapper<ICamApiFace>)

Classified analytic kind of the underlying surface

Declaration

public static TCamApiSurfaceKind SurfaceKind(this ComWrapper<ICamApiFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFace>	faceCom

Returns

Type	Description
TCamApiSurfaceKind