Class CurveBridgeModelItemHelper

Helper methods for ICamApiCurveBridgeModelItem — a single bridge (tab) on a 2D curve model item. Obtain via GetBridge(ComWrapper<ICamApiCurve2DModelItemWithBridges>, int) or AddBridge(ComWrapper<ICamApiCurve2DModelItemWithBridges>, double).

Inheritance

object

CurveBridgeModelItemHelper

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 CurveBridgeModelItemHelper

Methods

GetHeight(ComWrapper<ICamApiCurveBridgeModelItem>)

Get explicit bridge height (Mode and Value).

Declaration

public static (TBridgeHeightMode Mode, double Value) GetHeight(this ComWrapper<ICamApiCurveBridgeModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com

Returns

Type	Description
(TBridgeHeightMode Mode, double Value)

GetHeightIsDefault(ComWrapper<ICamApiCurveBridgeModelItem>)

True if bridge height is currently "By default".

Declaration

public static bool GetHeightIsDefault(this ComWrapper<ICamApiCurveBridgeModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com

Returns

Type	Description
bool

GetSize(ComWrapper<ICamApiCurveBridgeModelItem>)

Get explicit bridge size (Mode and Value).

Declaration

public static (TBridgeDimMode Mode, double Value) GetSize(this ComWrapper<ICamApiCurveBridgeModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com

Returns

Type	Description
(TBridgeDimMode Mode, double Value)

GetSizeIsDefault(ComWrapper<ICamApiCurveBridgeModelItem>)

True if bridge size is currently "By default".

Declaration

public static bool GetSizeIsDefault(this ComWrapper<ICamApiCurveBridgeModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com

Returns

Type	Description
bool

IsInvalid(ComWrapper<ICamApiCurveBridgeModelItem>)

True if the bridge is geometrically invalid (e.g. position overlaps another bridge or curve limits).

Declaration

public static bool IsInvalid(this ComWrapper<ICamApiCurveBridgeModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com

Returns

Type	Description
bool

Position(ComWrapper<ICamApiCurveBridgeModelItem>)

Position of bridge center along the curve, as a percentage of the curve full length. Valid range: 0..100. XML: BridgeCenterPercent.

Declaration

public static double Position(this ComWrapper<ICamApiCurveBridgeModelItem> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com

Returns

Type	Description
double

SetHeight(ComWrapper<ICamApiCurveBridgeModelItem>, TBridgeHeightMode, double)

Set explicit bridge height. When Mode=FullHeight, Value is ignored.

Declaration

public static void SetHeight(this ComWrapper<ICamApiCurveBridgeModelItem> com, TBridgeHeightMode mode, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com
TBridgeHeightMode	mode
double	value

SetHeightIsDefault(ComWrapper<ICamApiCurveBridgeModelItem>, bool)

Switch bridge height to "By default". XML: BridgeHeight.ValueType=Default.

Declaration

public static void SetHeightIsDefault(this ComWrapper<ICamApiCurveBridgeModelItem> com, bool isDefault)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com
bool	isDefault

SetPosition(ComWrapper<ICamApiCurveBridgeModelItem>, double)

Set position of bridge center along the curve, as a percentage of the curve full length. Valid range: 0..100.

Declaration

public static void SetPosition(this ComWrapper<ICamApiCurveBridgeModelItem> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com
double	value

SetSize(ComWrapper<ICamApiCurveBridgeModelItem>, TBridgeDimMode, double)

Set explicit bridge size. XML: BridgeSize.ValueType=Mode, BridgeSize.{Distance|Percent}Value=Value.

Declaration

public static void SetSize(this ComWrapper<ICamApiCurveBridgeModelItem> com, TBridgeDimMode mode, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com
TBridgeDimMode	mode
double	value

SetSizeIsDefault(ComWrapper<ICamApiCurveBridgeModelItem>, bool)

Switch bridge size to "By default" (operation default). XML: BridgeSize.ValueType=Default.

Declaration

public static void SetSizeIsDefault(this ComWrapper<ICamApiCurveBridgeModelItem> com, bool isDefault)

Parameters

Type	Name	Description
ComWrapper<ICamApiCurveBridgeModelItem>	com
bool	isDefault