Class PrismModelItemHelper

Helpers for ICamApiPrismModelItem — typed access to TopLevel, BottomLevel, Stock and AxisIndex on prism items added via AddPrismSelected(double, double, double, bool, int).

Inheritance

object

PrismModelItemHelper

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 PrismModelItemHelper

Methods

GetAxisIndex(ComWrapper<ICamApiPrismModelItem>)

Projection axis: 0=ToolAxis, 1=ContourPlane, 2=X, 3=Y, 4=Z, 5=CustomVector.

Declaration

public static int GetAxisIndex(this ComWrapper<ICamApiPrismModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com

Returns

Type	Description
int

GetBottomLevel(ComWrapper<ICamApiPrismModelItem>)

Bottom Z level of the prism (Zmin on the underlying TPrismItem).

Declaration

public static double GetBottomLevel(this ComWrapper<ICamApiPrismModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com

Returns

Type	Description
double

GetStock(ComWrapper<ICamApiPrismModelItem>)

Radial stock offset.

Declaration

public static double GetStock(this ComWrapper<ICamApiPrismModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com

Returns

Type	Description
double

GetTopLevel(ComWrapper<ICamApiPrismModelItem>)

Top Z level of the prism (Zmax on the underlying TPrismItem).

Declaration

public static double GetTopLevel(this ComWrapper<ICamApiPrismModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com

Returns

Type	Description
double

SetAxisIndex(ComWrapper<ICamApiPrismModelItem>, int)

Set AxisIndex (0=ToolAxis, 1=ContourPlane, 2=X, 3=Y, 4=Z, 5=CustomVector). Throws on out-of-range.

Declaration

public static void SetAxisIndex(this ComWrapper<ICamApiPrismModelItem> com, int value)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com
int	value

SetAxisIndex(ICamApiPrismModelItem, int)

Set AxisIndex (0=ToolAxis, 1=ContourPlane, 2=X, 3=Y, 4=Z, 5=CustomVector). Throws on out-of-range.

Declaration

public static void SetAxisIndex(this ICamApiPrismModelItem prism, int value)

Parameters

Type	Name	Description
ICamApiPrismModelItem	prism
int	value

SetBottomLevel(ComWrapper<ICamApiPrismModelItem>, double)

Set BottomLevel. Throws on NaN/Infinity.

Declaration

public static void SetBottomLevel(this ComWrapper<ICamApiPrismModelItem> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com
double	value

SetBottomLevel(ICamApiPrismModelItem, double)

Set BottomLevel. Throws on NaN/Infinity.

Declaration

public static void SetBottomLevel(this ICamApiPrismModelItem prism, double value)

Parameters

Type	Name	Description
ICamApiPrismModelItem	prism
double	value

SetStock(ComWrapper<ICamApiPrismModelItem>, double)

Set Stock. Throws on NaN/Infinity.

Declaration

public static void SetStock(this ComWrapper<ICamApiPrismModelItem> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com
double	value

SetStock(ICamApiPrismModelItem, double)

Set Stock. Throws on NaN/Infinity.

Declaration

public static void SetStock(this ICamApiPrismModelItem prism, double value)

Parameters

Type	Name	Description
ICamApiPrismModelItem	prism
double	value

SetTopLevel(ComWrapper<ICamApiPrismModelItem>, double)

Set TopLevel. Throws on NaN/Infinity.

Declaration

public static void SetTopLevel(this ComWrapper<ICamApiPrismModelItem> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiPrismModelItem>	com
double	value

SetTopLevel(ICamApiPrismModelItem, double)

Set TopLevel. Throws on NaN/Infinity.

Declaration

public static void SetTopLevel(this ICamApiPrismModelItem prism, double value)

Parameters

Type	Name	Description
ICamApiPrismModelItem	prism
double	value