CIP C++ documentation for class "wfcWDimension"

Class wfcWDimension

# include <wfcDimension.h> class wfcWDimension : public virtual wfcAnnotation, : public virtual pfcDimension { xaideclare(wfcWDimension) ... };

Description

Extends the functionality ofpfcDimension

This is the actual type of Dimension Items in Object Toolkit.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`void`	`AddAdditionalReferences (wfcDimensionReferenceType RefType, wfcAnnotationReferences_ptr Refs)`
	Add dimension references.

`xbool`	`CanRegenerate (optional pfcDrawing_ptr Drw)`


`optional wfcAnnotationElement_ptr`	`CreateAnnotationElement (wfcAnnotationPlane_ptr Plane)`
	LICENSE: 222

`void`	`CreateJog (pfcPoint3Ds_ptr JogPoints, xint WitnessLineIndex, optional pfcDrawing_ptr Drawing)`
	LICENSE: 222

`void`	`CreateSimpleBreak (pfcPoint3D_ptr BreakStart, pfcPoint3D_ptr BreakEnd, xint WitnessLineIndex, optional pfcDrawing_ptr Drawing)`
	LICENSE: 222

`void`	`Delete ()`
	LICENSE: 222

`void`	`DeleteAdditionalReferences (wfcDimensionReferenceType RefType, xint Index)`
	Delete dimension reference.

`void`	`DeleteAnnotationElement ()`
	LICENSE: 222

`void`	`DisplayValueAsRounded (xbool Value)`


`void`	`EraseWitnessLine (xint WitnessLineIndex, optional pfcDrawing_ptr Drawing)`


`wfcAnnotationReferences_ptr`	`GetAdditionalReferences (wfcDimensionReferenceType RefType)`
	Get dimension references.

`wfcAnnotationPlane_ptr`	`GetAnnotationPlane ()`
	LICENSE: 222

`optional pfcDimension_ptr`	`GetBaselineDimension ()`
	LICENSE: 222

`wfcDimBound`	`GetBound ()`


`optional wfcDimChamferLeaderStyle`	`GetChamferLeaderStyle (optional pfcDrawing_ptr Drw)`


`optional wfcDimChamferStyle`	`GetChamferStyle (optional pfcDrawing_ptr Drawing)`
	LICENSE: 222

`wfcDimLeaderConfig`	`GetConfiguration (optional pfcDrawing_ptr Drw)`
	Obtains the dimension configuration.

`optional xint`	`GetDenominator (xbool Tolerance)`


`pfcDimensionAttachments_ptr`	`GetDimensionAttachPoints ()`
	LICENSE: 222

`pfcDimSenses_ptr`	`GetDimensionSenses ()`
	LICENSE: 222

`wfcDimLocation_ptr`	`GetDimLocation (optional pfcDrawing_ptr Drawing, optional pfcView_ptr View)`


`optional xreal`	`GetDisplayedLowerLimitTolerance ()`


`optional xreal`	`GetDisplayedUpperLimitTolerance ()`


`xreal`	`GetDisplayedValue ()`


`wfcDimValueDisplay`	`GetDisplayedValueType ()`


`wfcDimensionDisplayFormat`	`GetDisplayFormat ()`
	Get display format of dimension.

`wfcDualDimensionInstructions_ptr`	`GetDualOptions (optional pfcDrawing_ptr Drw)`
	Gets the dual dimension display options.

`wfcEnvelope3D_ptr`	`GetEnvelope (optional pfcDrawing_ptr Drawing, xint Line)`
	Get the envelope of a line in a specified dimension. For getting coordinates of dimension displayed in solid and same dimension is displayed in drawing then drawing should not be active.

`wfcLeaderArrowType`	`GetFirstDimArrowType (optional pfcDrawing_ptr Drawing, optional pfcView_ptr View)`
	LICENSE: 222 Returns the arrow type used for first dimension arrow.

`xreal`	`GetNominalValue ()`


`wfcDimOrdinateStandard`	`GetOrdinateStandard ()`
	LICENSE: 222

`pfcDimOrientationHint`	`GetOrientationHint ()`
	LICENSE: 222

`optional xint`	`GetOriginSide ()`
	Identify if dimension has an origin side

`optional xreal`	`GetOverrideValue ()`


`optional pfcFeature_ptr`	`GetOwnerFeature ()`


`optional pfcDimension_ptr`	`GetParentDimension ()`
	Retrieves the parent dimension of the value dependent dimension.

`optional xstring`	`GetPrefix ()`


`optional wfcLeaderArrowType`	`GetSecondDimArrowType (optional pfcDrawing_ptr Drawing, optional pfcView_ptr View)`
	LICENSE: 222 Returns the arrow type used for second dimension arrow.

`optional xint`	`GetSignificantDigits (xbool Tolerance)`


`optional xstring`	`GetSuffix ()`


`xstringsequence_ptr`	`GetSymbolModeText ()`


`xbool`	`IsAccessibleInModel ()`


`xbool`	`IsBaseline ()`
	LICENSE: 222

`xbool`	`IsBasic ()`


`xbool`	`IsDisplayedValueRounded ()`


`xbool`	`IsDriving ()`
	LICENSE: 222

`xbool`	`IsFractional ()`


`xbool`	`IsInspection ()`


`xbool`	`IsOrdinate ()`
	LICENSE: 222

`xbool`	`IsSignDriven ()`
	Identifies if the dimension always uses a true sign.

`xbool`	`IsToleranceDisplayed ()`


`void`	`LinearDimensionToOrdinate (pfcDimension_ptr Dimension)`
	LICENSE: 222

`void`	`Move (pfcPoint3D_ptr Location)`
	LICENSE: 222

`void`	`OrdinateDimensionToLinear ()`
	LICENSE: 222

`void`	`SetAnnotationPlane (wfcAnnotationPlane_ptr Plane)`
	LICENSE: 222

`void`	`SetAsBasic (xbool Basic)`


`void`	`SetAsInspection (xbool Inspection)`


`void`	`SetBound (pfcModel_ptr Model, wfcDimBound DimBound)`


`void`	`SetChamferLeaderStyle (wfcDimChamferLeaderStyle ChamferLeaderStyle, optional pfcDrawing_ptr Drw)`


`void`	`SetChamferStyle (wfcDimChamferStyle ChamferStyle, optional pfcDrawing_ptr Drawing)`
	LICENSE: 222

`void`	`SetConfiguration (wfcDimLeaderConfig Config, optional pfcDrawing_ptr Drw)`
	Assigns the dimension configuration.

`void`	`SetDenominator (xint Denominator, xbool Tolerance)`


`void`	`SetDimensionArrowType (xint ArrowIndex, wfcLeaderArrowType ArrowType, optional pfcDrawing_ptr Drawing)`


`void`	`SetDimensionAttachPoints (pfcDimensionAttachments_ptr DimAttachments, pfcDimSenses_ptr DimSenses, pfcDimOrientationHint OrientHint, wfcAnnotationPlane_ptr AnnotPlane)`
	LICENSE: 222

`void`	`SetDisplayedValueType (wfcDimValueDisplay DisplayValueType)`


`void`	`SetDisplayFormat (wfcDimensionDisplayFormat Format)`
	Set display format of dimension.

`void`	`SetDualOptions (optional pfcDrawing_ptr Drw, wfcDualDimensionInstructions_ptr DDInst)`
	Sets the dual dimension display using specified options.

`void`	`SetElbowLength (xreal ElbowLength, optional pfcDrawing_ptr Drw)`


`void`	`SetOrdinateReferences (pfcDimensionAttachment_ptr DimAttachment, pfcDimSenses_ptr DimSenses, pfcDimOrientationHint OrientHint)`
	LICENSE: 222

`void`	`SetOrdinateStandard (wfcDimOrdinateStandard Standard)`
	LICENSE: 222

`void`	`SetOriginSide (xint WitnessLineIndex)`
	Sets origin side to dimension.

`void`	`SetOverrideValue (xreal Value)`


`void`	`SetPrefix (xrstring Prefix)`


`void`	`SetSignificantDigits (xint Digits, xbool Tolerance)`


`void`	`SetSuffix (xrstring Suffix)`


`void`	`ShowWitnessLine (optional pfcDrawing_ptr Drawing)`

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class wfcAnnotation:: ShowInDrawing, Display, DisplayInDrawing, Undisplay, UndisplayInDrawing, IsShown, Update, GetTextStyle, SetTextStyle, GetTextStyleInDrawing, SetTextStyleInDrawing, UpdateAttachment, UpdatePosition, IsAssociative, GetAttachmentAssociativity, GetAnnotationElement, IsInactive, Rotate, ConvertLegacy, NeedsConversion, GetSecurityMarking, SetSecurityMarking, IsUsingXSecReference

Methods Inherited from Class pfcBaseParameter:: GetValue, SetValue, GetIsDesignated, SetIsDesignated, GetIsRelationDriven, GetIsModified, ResetFromBackup

Methods Inherited from Class pfcBaseDimension:: GetDimValue, SetDimValue, GetDimType, GetSymbol, SetSymbol, GetTexts, SetTexts, GetExtendsInNegativeDirection, Show, Erase

Methods Inherited from Class pfcDimension:: GetTolerance, SetTolerance, IsReference

Method Detail

xreal GetNominalValue ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

void SetBound (pfcModel_ptr Model, wfcDimBound DimBound)

Exceptions thrown (but not limited to):

pfcXToolkitCantModify- The dimension's owner model or the TableModel are read-only.

pfcXToolkitBadContext- cannot set bound for this dimension.

pfcXToolkitCantWrite- Could not modify the given item because it has read-only access.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Model
DimBound

Returns:

wfcDimBound GetBound ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

xstringsequence_ptr GetSymbolModeText ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

xbool IsFractional ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

optional xint GetSignificantDigits (xbool Tolerance)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The number of decimals is driven by the number of decimals for the dimension.

pfcXToolkitBadContext- The dimension is fractional.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Parameters:

Tolerance

Returns:

void SetSignificantDigits (xint Digits, xbool Tolerance)

Exceptions thrown (but not limited to):

pfcXToolkitBadContext- The dimension is fractional, so this value cannot be set.

pfcXToolkitNotValid- The input "decimals" argument is out-of-range .

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Digits
Tolerance

Returns:

optional xint GetDenominator (xbool Tolerance)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The denominator is driven by the denominator for the dimension.

pfcXToolkitBadContext- The dimension is not fractional.

Manual References:: Dimensions and Parameters: Dimension Information

Parameters:

Tolerance

Returns:

void SetDenominator (xint Denominator, xbool Tolerance)

Exceptions thrown (but not limited to):

pfcXToolkitBadContext- The dimension is not fractional.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Denominator
Tolerance

Returns:

xbool CanRegenerate (optional pfcDrawing_ptr Drw)

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Dimensions and Parameters: Accessing Reference and Driven Dimensions

Parameters:

Drw

Returns:

optional xstring GetPrefix ()

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType- The dimension type is invalid.

pfcXToolkitNotFound- The dimension or prefix is not found.

Manual References:: Dimensions and Parameters: Dimension Prefix and Suffix, Dimensions and Parameters: Dimension Prefix and Suffix

Returns:

void SetPrefix (xrstring Prefix)

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType- The dimension type is invalid.

pfcXToolkitNotFound- The dimension isn't found.

pfcXToolkitCantModify- The dimension isn't modifiable.

Manual References:: Dimensions and Parameters: Dimension Prefix and Suffix, Dimensions and Parameters: Dimension Prefix and Suffix

Parameters:

Prefix

Returns:

optional xstring GetSuffix ()

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType- The dimension type is invalid.

pfcXToolkitNotFound- The dimension or suffix is not found.

Manual References:: Dimensions and Parameters: Dimension Prefix and Suffix, Dimensions and Parameters: Dimension Prefix and Suffix

Returns:

void SetSuffix (xrstring Suffix)

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType- The dimension type is invalid.

pfcXToolkitNotFound- The dimension isn't found.

pfcXToolkitCantModify- The dimension isn't modifiable.

Manual References:: Dimensions and Parameters: Dimension Prefix and Suffix

Parameters:

Suffix

Returns:

xbool IsToleranceDisplayed ()

Manual References:: Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances

Returns:

xbool IsBasic ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

xbool IsInspection ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

void SetAsInspection (xbool Inspection)

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite- Could not modify the given item because it has read-only access.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Inspection

Returns:

void SetAsBasic (xbool Basic)

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite- Could not modify the given item because it has read-only access.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Basic

Returns:

optional pfcFeature_ptr GetOwnerFeature ()

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension is not owned by a particular feature.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

xreal GetDisplayedValue ()

Exceptions thrown (but not limited to):

pfcXToolkitAmbiguous- The displayed format is not decimal

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

optional xreal GetDisplayedUpperLimitTolerance ()

Exceptions thrown (but not limited to):

pfcXToolkitAmbiguous- The displayed format is not decimal

Manual References:: Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances

Returns:

optional xreal GetDisplayedLowerLimitTolerance ()

Exceptions thrown (but not limited to):

pfcXToolkitAmbiguous- The displayed format is not decimal

Manual References:: Dimensions and Parameters: Dimension Tolerances

Returns:

void DisplayValueAsRounded (xbool Value)

Exceptions thrown (but not limited to):

pfcXToolkitNoChange- The input attribute is the same as an existing one

pfcXToolkitCantModify- Modification of the attribute is not allowed

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Parameters:

Value

Returns:

xbool IsDisplayedValueRounded ()

Exceptions thrown (but not limited to):

pfcXToolkitBadContext- Option is set, but the display is not decimal

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

optional xreal GetOverrideValue ()

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The override value is not set.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

void SetOverrideValue (xreal Value)

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Value

Returns:

wfcDimValueDisplay GetDisplayedValueType ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

void SetDisplayedValueType (wfcDimValueDisplay DisplayValueType)

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

DisplayValueType

Returns:

void SetElbowLength (xreal ElbowLength, optional pfcDrawing_ptr Drw)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension is not a chamfer dimension.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

ElbowLength
Drw

Returns:

optional wfcDimChamferLeaderStyle GetChamferLeaderStyle (optional pfcDrawing_ptr Drw)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension is not a chamfer dimension.

Manual References:: Dimensions and Parameters: 45 Degree Chamfer Dimensions, Dimensions and Parameters: 45 Degree Chamfer Dimensions

Parameters:

Drw

Returns:

void SetChamferLeaderStyle (wfcDimChamferLeaderStyle ChamferLeaderStyle, optional pfcDrawing_ptr Drw)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension style is not chamfer.

Manual References:: Dimensions and Parameters: 45 Degree Chamfer Dimensions, Dimensions and Parameters: 45 Degree Chamfer Dimensions

Parameters:

ChamferLeaderStyle
Drw

Returns:

wfcDimLeaderConfig GetConfiguration (optional pfcDrawing_ptr Drw)

Obtains the dimension configuration.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- Dimension not found.

Manual References:: Dimensions and Parameters: 45 Degree Chamfer Dimensions, Dimensions and Parameters: 45 Degree Chamfer Dimensions

Parameters:

Drw: Optional - The Drawing if dimension belongs to a drawing.

Returns:: wfcDimLeaderConfig - Dimension leader configuration

void SetConfiguration (wfcDimLeaderConfig Config, optional pfcDrawing_ptr Drw)

Assigns the dimension configuration.

Manual References:: Dimensions and Parameters: 45 Degree Chamfer Dimensions, Dimensions and Parameters: 45 Degree Chamfer Dimensions

Parameters:

Config: Dimension leader configuration to assign.
Drw: Optional - The Drawing if dimension belongs to a drawing.

Returns:

xbool IsSignDriven ()

Identifies if the dimension always uses a true sign.

Note:for dimensions which use the sign to flip the direction, this behavior can be overridden by setting the config option 'show_dim_sign' to 'yes'. By default it is set to 'no'.

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:: xbool - boolean indicating if dimension is sign driven or not.

void CreateSimpleBreak (pfcPoint3D_ptr BreakStart, pfcPoint3D_ptr BreakEnd, xint WitnessLineIndex, optional pfcDrawing_ptr Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantModify- The object or cosmetic model can't be modified.

pfcXToolkitInvalidItem- The dimension is not valid.

pfcXToolkitInvalidType- The dimension can't have a witness line break.

pfcXToolkitAbort- The dimension witness line couldn't be broken.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

BreakStart
BreakEnd
WitnessLineIndex
Drawing

Returns:

void CreateJog (pfcPoint3Ds_ptr JogPoints, xint WitnessLineIndex, optional pfcDrawing_ptr Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantModify- The object or cosmetic model can't be modified.

pfcXToolkitInvalidItem- The dimension is not valid for this operation.

pfcXToolkitInvalidType- The dimension can't have a witness line jog.

pfcXToolkitAbort- The dimension witness line couldn't be jogged.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

JogPoints
WitnessLineIndex
Drawing

Returns:

wfcDimLocation_ptr GetDimLocation (optional pfcDrawing_ptr Drawing, optional pfcView_ptr View)

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed- The function succeeded, but only after internally selecting a default orientation where one was not supplied, for a dimension which could have different locations given different views. This error can only occur if both drawing and view are NULL.

pfcXToolkitNotFound- This dimension is not displayable.

pfcXToolkitNotValid- A drawing view was passed with a drawing.

Parameters:

Drawing
View

Returns:

wfcLeaderArrowType GetFirstDimArrowType (optional pfcDrawing_ptr Drawing, optional pfcView_ptr View)

LICENSE: 222

Returns the arrow type used for first dimension arrow.

Parameters:

Drawing: The drawing handle. Passnullif not using a drawing.
View: The orientation of the model that will be applied before determining the arrow type. Pass nullto use the current model view, if the model is current, or a default model orientation otherwise. Pass nullif using a drawing.

Returns:: The arrow type for first dimension arrow.

optional wfcLeaderArrowType GetSecondDimArrowType (optional pfcDrawing_ptr Drawing, optional pfcView_ptr View)

LICENSE: 222

Returns the arrow type used for second dimension arrow.

Parameters:

Drawing: The drawing handle. Passnullif not using a drawing.
View: The orientation of the model that will be applied before determining the arrow type. Pass nullto use the current model view, if the model is current, or a default model orientation otherwise. Pass nullif using a drawing.

Returns:: The arrow type for second dimension arrow.

void Delete ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite- Could not delete the given item because it has read-only access.

pfcXToolkitInvalidItem- The input dimension is invalid (non-driven).

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Dimensions and Parameters: Accessing Reference and Driven Dimensions

Returns:

xbool IsDriving ()

LICENSE: 222

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Dimensions and Parameters: Accessing Reference and Driven Dimensions

Returns:

void SetAnnotationPlane (wfcAnnotationPlane_ptr Plane)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitInvalidMatrix- The orientation cannot be used for the input dimension.

pfcXToolkitNotValid- For a driving dimension annotation element, the annotation orientation provided is not frozen.

pfcXToolkitBadContext- The driving dimension is not in an annotation element.

Manual References:: Dimensions and Parameters: Dimension Orientation, Dimensions and Parameters: Dimension Orientation

Parameters:

Plane

Returns:

wfcAnnotationPlane_ptr GetAnnotationPlane ()

LICENSE: 222

Manual References:: Dimensions and Parameters: Dimension Orientation

Returns:

void Move (pfcPoint3D_ptr Location)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Automatic Propagation of Annotation Elements

Parameters:

Location

Returns:

xbool IsBaseline ()

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Baseline Dimensions, Annotations: Annotation Features and Annotations: Baseline Dimensions

Returns:

xbool IsAccessibleInModel ()

Manual References:: Dimensions and Parameters: Dimension Information, Dimensions and Parameters: Dimension Information

Returns:

void SetOrdinateStandard (wfcDimOrdinateStandard Standard)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantModify- The input ordinate dimension is not a baseline dimension.

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions

Parameters:

Standard

Returns:

wfcDimOrdinateStandard GetOrdinateStandard ()

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions

Returns:

xbool IsOrdinate ()

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions

Returns:

optional pfcDimension_ptr GetBaselineDimension ()

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Baseline Dimensions, Annotations: Annotation Features and Annotations: Baseline Dimensions

Returns:

optional wfcAnnotationElement_ptr CreateAnnotationElement (wfcAnnotationPlane_ptr Plane)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType- The dimension is not a driving dimension.

pfcXToolkitInvalidItem- This type of driving dimension is not suitable for incorporation into a driving dimension annotation element.

pfcXToolkitFound- The dimension already has an annotation element.

pfcXToolkitInvalidMatrix- The orientation provided cannot be used for this dimension.

Manual References:: Dimensions and Parameters: Driving Dimension Annotation Elements, Dimensions and Parameters: Driving Dimension Annotation Elements

Parameters:

Plane

Returns:

void DeleteAnnotationElement ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension does not have an annotation element.

Manual References:: Dimensions and Parameters: Driving Dimension Annotation Elements

Returns:

optional wfcDimChamferStyle GetChamferStyle (optional pfcDrawing_ptr Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension is not a chamfer dimension.

Manual References:: Dimensions and Parameters: 45 Degree Chamfer Dimensions, Dimensions and Parameters: 45 Degree Chamfer Dimensions

Parameters:

Drawing

Returns:

void SetChamferStyle (wfcDimChamferStyle ChamferStyle, optional pfcDrawing_ptr Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension style is not chamfer.

Manual References:: Dimensions and Parameters: 45 Degree Chamfer Dimensions

Parameters:

ChamferStyle
Drawing

Returns:

pfcDimensionAttachments_ptr GetDimensionAttachPoints ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem- The input dimension is invalid (non-driven).

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Dimensions and Parameters: Accessing Reference and Driven Dimensions

Returns:

pfcDimSenses_ptr GetDimensionSenses ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem- The input dimension is invalid (non-driven).

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Dimensions and Parameters: Accessing Reference and Driven Dimensions

Returns:

pfcDimOrientationHint GetOrientationHint ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem- The input dimension is invalid (non-driven).

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Dimensions and Parameters: Accessing Reference and Driven Dimensions

Returns:

void SetDimensionAttachPoints (pfcDimensionAttachments_ptr DimAttachments, pfcDimSenses_ptr DimSenses, pfcDimOrientationHint OrientHint, wfcAnnotationPlane_ptr AnnotPlane)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadDimAttach- A dimension could not be created with the attachments and sense specified.

pfcXToolkitCantWrite- Could not modify the given item because it has read-only access.

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions

Parameters:

DimAttachments
DimSenses
OrientHint
AnnotPlane

Returns:

void EraseWitnessLine (xint WitnessLineIndex, optional pfcDrawing_ptr Drawing)

Exceptions thrown (but not limited to):

pfcXToolkitNoChange- The dimension witnessline could not be erased.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

WitnessLineIndex
Drawing

Returns:

void ShowWitnessLine (optional pfcDrawing_ptr Drawing)

Exceptions thrown (but not limited to):

pfcXToolkitNoChange- The dimension witnessline could not be shown or input dimension does not have erased witnessline.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

Drawing

Returns:

void SetOrdinateReferences (pfcDimensionAttachment_ptr DimAttachment, pfcDimSenses_ptr DimSenses, pfcDimOrientationHint OrientHint)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitBadDimAttach- Invalid attachment geometry for this ordinate dimension.

pfcXToolkitInvalidType- The dimension is not an ordinate dimension.

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions

Parameters:

DimAttachment
DimSenses
OrientHint

Returns:

void OrdinateDimensionToLinear ()

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite- Could not modify the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions, Annotations: Annotation Features and Annotations: Ordinate Dimensions

Returns:

void LinearDimensionToOrdinate (pfcDimension_ptr Dimension)

LICENSE: 222

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite- Could not modify the given item because it has read-only access.

Manual References:: Annotations: Annotation Features and Annotations: Ordinate Dimensions

Parameters:

Dimension

Returns:

void SetDimensionArrowType (xint ArrowIndex, wfcLeaderArrowType ArrowType, optional pfcDrawing_ptr Drawing)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The dimension does not exist.

pfcXToolkitInvalidPtr- The dimension owner is invalid.

pfcXToolkitCantModify- The dimension cannot be modified.

Manual References:: Dimensions and Parameters: Modifying Dimensions, Dimensions and Parameters: Modifying Dimensions

Parameters:

ArrowIndex
ArrowType
Drawing

Returns:

optional pfcDimension_ptr GetParentDimension ()

Retrieves the parent dimension of the value dependent dimension.

Returns:: The parent dimension.

optional xint GetOriginSide ()

Identify if dimension has an origin side

Returns:: The witness line index: 1 or 2. Returns -1 if dimension has no origin side.

void SetOriginSide (xint WitnessLineIndex)

Sets origin side to dimension.

Parameters:

WitnessLineIndex: The witness line index: 1 or 2. Pass -1 to remove origin set on either side.

Returns:

wfcDualDimensionInstructions_ptr GetDualOptions (optional pfcDrawing_ptr Drw)

Gets the dual dimension display options.

Parameters:

Drw: The drawing handle. Pass nullif not using a drawing.

Returns:: The dual dimension instructions object.

void SetDualOptions (optional pfcDrawing_ptr Drw, wfcDualDimensionInstructions_ptr DDInst)

Sets the dual dimension display using specified options.

Parameters:

Drw: The drawing handle. Pass nullif not using a drawing.
DDInst: The dual dimension instructions object.

Returns:

wfcDimensionDisplayFormat GetDisplayFormat ()

Get display format of dimension.

Returns:: The dimension display format type.

void SetDisplayFormat (wfcDimensionDisplayFormat Format)

Set display format of dimension.

Parameters:

Format: The dimension display format type.

Returns:

wfcAnnotationReferences_ptr GetAdditionalReferences (wfcDimensionReferenceType RefType)

Get dimension references.

Parameters:

RefType: The type of dimension reference.

Returns:: Sequence of additional references.

void AddAdditionalReferences (wfcDimensionReferenceType RefType, wfcAnnotationReferences_ptr Refs)

Add dimension references.

Parameters:

RefType: The type of dimension reference.
Refs: Sequence of additional references to add.

Returns:

void DeleteAdditionalReferences (wfcDimensionReferenceType RefType, xint Index)

Delete dimension reference.

Parameters:

RefType: The type of dimension reference.
Index: The index of reference to delete. Indices start from 0. Get additional references using wfcWDimension::GetAdditionalReferences(wfcDimensionReferenceType).

Returns:

wfcEnvelope3D_ptr GetEnvelope (optional pfcDrawing_ptr Drawing, xint Line)

Get the envelope of a line in a specified dimension. For getting coordinates of dimension displayed in solid and same dimension is displayed in drawing then drawing should not be active.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound- The indicated line does not exist.

Manual References:: Dimensions and Parameters: Modifying Dimensions

Parameters:

Drawing: Pass only for solid dim shown in drawing. Otherwise pass NULL.
Line: The line number of the dimension.

Returns:: The envelope surrounding the text line, in the model's coordinate system. For drawing it is in the screen coordinates.