CIP JAVA documentation for class "com.ptc.wfc.wfcDimension.WDimension"

Interface WDimension

package com.ptc.wfc.wfcDimension; public interface WDimension extends com.ptc.wfc.wfcAnnotation.Annotation, com.ptc.pfc.pfcDimension.Dimension

Description

Extends the functionality ofDimension

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

Method Summary
`void`	`AddAdditionalReferences (DimensionReferenceType RefType, AnnotationReferences Refs)` Add dimension references.
`boolean`	`CanRegenerate ( /optional/ Drawing Drw)`
`/optional/ AnnotationElement`	`CreateAnnotationElement (AnnotationPlane Plane)` `LICENSE: 222`
`void`	`CreateJog (Point3Ds JogPoints, int WitnessLineIndex, /optional/ Drawing Drawing)` `LICENSE: 222`
`void`	`CreateSimpleBreak (Point3D BreakStart, Point3D BreakEnd, int WitnessLineIndex, /optional/ Drawing Drawing)` `LICENSE: 222`
`void`	`Delete ()` `LICENSE: 222`
`void`	`DeleteAdditionalReferences (DimensionReferenceType RefType, int Index)` Delete dimension reference.
`void`	`DeleteAnnotationElement ()` `LICENSE: 222`
`void`	`DisplayValueAsRounded (boolean Value)`
`void`	`EraseWitnessLine (int WitnessLineIndex, /optional/ Drawing Drawing)`
`AnnotationReferences`	`GetAdditionalReferences (DimensionReferenceType RefType)` Get dimension references.
`AnnotationPlane`	`GetAnnotationPlane ()` `LICENSE: 222`
`/optional/ Dimension`	`GetBaselineDimension ()` `LICENSE: 222`
`DimBound`	`GetBound ()`
`/optional/ DimChamferLeaderStyle`	`GetChamferLeaderStyle ( /optional/ Drawing Drw)`
`/optional/ DimChamferStyle`	`GetChamferStyle ( /optional/ Drawing Drawing)` `LICENSE: 222`
`DimLeaderConfig`	`GetConfiguration ( /optional/ Drawing Drw)` Obtains the dimension configuration.
`/optional/ Integer`	`GetDenominator (boolean Tolerance)`
`DimensionAttachments`	`GetDimensionAttachPoints ()` `LICENSE: 222`
`DimSenses`	`GetDimensionSenses ()` `LICENSE: 222`
`DimLocation`	`GetDimLocation ( /optional/ Drawing Drawing, /optional/ View View)`
`/optional/ Double`	`GetDisplayedLowerLimitTolerance ()`
`/optional/ Double`	`GetDisplayedUpperLimitTolerance ()`
`double`	`GetDisplayedValue ()`
`DimValueDisplay`	`GetDisplayedValueType ()`
`DimensionDisplayFormat`	`GetDisplayFormat ()` Get display format of dimension.
`DualDimensionInstructions`	`GetDualOptions ( /optional/ Drawing Drw)` Gets the dual dimension display options.
`Envelope3D`	`GetEnvelope ( /optional/ Drawing Drawing, int 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.
`LeaderArrowType`	`GetFirstDimArrowType ( /optional/ Drawing Drawing, /optional/ View View)` `LICENSE: 222` Returns the arrow type used for first dimension arrow.
`double`	`GetNominalValue ()`
`DimOrdinateStandard`	`GetOrdinateStandard ()` `LICENSE: 222`
`DimOrientationHint`	`GetOrientationHint ()` `LICENSE: 222`
`/optional/ Integer`	`GetOriginSide ()` Identify if dimension has an origin side
`/optional/ Double`	`GetOverrideValue ()`
`/optional/ Feature`	`GetOwnerFeature ()`
`/optional/ Dimension`	`GetParentDimension ()` Retrieves the parent dimension of the value dependent dimension.
`/optional/ String`	`GetPrefix ()`
`/optional/ LeaderArrowType`	`GetSecondDimArrowType ( /optional/ Drawing Drawing, /optional/ View View)` `LICENSE: 222` Returns the arrow type used for second dimension arrow.
`/optional/ Integer`	`GetSignificantDigits (boolean Tolerance)`
`/optional/ String`	`GetSuffix ()`
`stringseq`	`GetSymbolModeText ()`
`boolean`	`IsAccessibleInModel ()`
`boolean`	`IsBaseline ()` `LICENSE: 222`
`boolean`	`IsBasic ()`
`boolean`	`IsDisplayedValueRounded ()`
`boolean`	`IsDriving ()` `LICENSE: 222`
`boolean`	`IsFractional ()`
`boolean`	`IsInspection ()`
`boolean`	`IsOrdinate ()` `LICENSE: 222`
`boolean`	`IsSignDriven ()` Identifies if the dimension always uses a true sign.
`boolean`	`IsToleranceDisplayed ()`
`void`	`LinearDimensionToOrdinate (Dimension Dimension)` `LICENSE: 222`
`void`	`Move (Point3D Location)` `LICENSE: 222`
`void`	`OrdinateDimensionToLinear ()` `LICENSE: 222`
`void`	`SetAnnotationPlane (AnnotationPlane Plane)` `LICENSE: 222`
`void`	`SetAsBasic (boolean Basic)`
`void`	`SetAsInspection (boolean Inspection)`
`void`	`SetBound (Model Model, DimBound DimBound)`
`void`	`SetChamferLeaderStyle (DimChamferLeaderStyle ChamferLeaderStyle, /optional/ Drawing Drw)`
`void`	`SetChamferStyle (DimChamferStyle ChamferStyle, /optional/ Drawing Drawing)` `LICENSE: 222`
`void`	`SetConfiguration (DimLeaderConfig Config, /optional/ Drawing Drw)` Assigns the dimension configuration.
`void`	`SetDenominator (int Denominator, boolean Tolerance)`
`void`	`SetDimensionArrowType (int ArrowIndex, LeaderArrowType ArrowType, /optional/ Drawing Drawing)`
`void`	`SetDimensionAttachPoints (DimensionAttachments DimAttachments, DimSenses DimSenses, DimOrientationHint OrientHint, AnnotationPlane AnnotPlane)` `LICENSE: 222`
`void`	`SetDisplayedValueType (DimValueDisplay DisplayValueType)`
`void`	`SetDisplayFormat (DimensionDisplayFormat Format)` Set display format of dimension.
`void`	`SetDualOptions ( /optional/ Drawing Drw, DualDimensionInstructions DDInst)` Sets the dual dimension display using specified options.
`void`	`SetElbowLength (double ElbowLength, /optional/ Drawing Drw)`
`void`	`SetOrdinateReferences (DimensionAttachment DimAttachment, DimSenses DimSenses, DimOrientationHint OrientHint)` `LICENSE: 222`
`void`	`SetOrdinateStandard (DimOrdinateStandard Standard)` `LICENSE: 222`
`void`	`SetOriginSide (int WitnessLineIndex)` Sets origin side to dimension.
`void`	`SetOverrideValue (double Value)`
`void`	`SetPrefix (String Prefix)`
`void`	`SetSignificantDigits (int Digits, boolean Tolerance)`
`void`	`SetSuffix (String Suffix)`
`void`	`ShowWitnessLine ( /optional/ Drawing Drawing)`

Methods Inherited from Interface `com.ptc.wfc.wfcLayerState.LayerItem`
`IsLayerItemVisible`, `RemoveNoUpdate`, `GetLayers`, `AddNoUpdate`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Methods Inherited from Interface `com.ptc.wfc.wfcAnnotation.Annotation`
`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 Interface com.ptc.wfc.wfcAnnotation.Annotation

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 Interface `com.ptc.pfc.pfcModelItem.BaseParameter`
`GetValue`, `SetValue`, `GetIsDesignated`, `SetIsDesignated`, `GetIsRelationDriven`, `GetIsModified`, `ResetFromBackup`

Methods Inherited from Interface `com.ptc.pfc.pfcDimension.BaseDimension`
`GetDimValue`, `SetDimValue`, `GetDimType`, `GetSymbol`, `SetSymbol`, `GetTexts`, `SetTexts`, `GetExtendsInNegativeDirection`, `Show`, `Erase`

Methods Inherited from Interface `com.ptc.pfc.pfcDimension.Dimension`
`GetTolerance`, `SetTolerance`, `IsReference`

Method Detail

GetNominalValue

double GetNominalValue ()

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

Returns:

SetBound

void SetBound (Model Model, DimBound DimBound)

Exceptions thrown (but not limited to):

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

XToolkitBadContext- cannot set bound for this dimension.

XToolkitCantWrite- 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:

GetBound

DimBound GetBound ()

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

Returns:

GetSymbolModeText

stringseq GetSymbolModeText ()

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

Returns:

IsFractional

boolean IsFractional ()

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

Returns:

GetSignificantDigits

/*optional*/ Integer GetSignificantDigits (boolean Tolerance)

Exceptions thrown (but not limited to):

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

XToolkitBadContext- The dimension is fractional.

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

Parameters:

Tolerance

Returns:

SetSignificantDigits

void SetSignificantDigits (int Digits, boolean Tolerance)

Exceptions thrown (but not limited to):

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

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

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

Parameters:

Digits
Tolerance

Returns:

GetDenominator

/*optional*/ Integer GetDenominator (boolean Tolerance)

Exceptions thrown (but not limited to):

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

XToolkitBadContext- The dimension is not fractional.

Manual References:: Dimensions and Parameters: Dimension Information

Parameters:

Tolerance

Returns:

SetDenominator

void SetDenominator (int Denominator, boolean Tolerance)

Exceptions thrown (but not limited to):

XToolkitBadContext- The dimension is not fractional.

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

Parameters:

Denominator
Tolerance

Returns:

CanRegenerate

boolean CanRegenerate ( /*optional*/ Drawing Drw)

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

Parameters:

Drw

Returns:

GetPrefix

/*optional*/ String GetPrefix ()

Exceptions thrown (but not limited to):

XToolkitInvalidType- The dimension type is invalid.

XToolkitNotFound- The dimension or prefix is not found.

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

Returns:

SetPrefix

void SetPrefix (String Prefix)

Exceptions thrown (but not limited to):

XToolkitInvalidType- The dimension type is invalid.

XToolkitNotFound- The dimension isn't found.

XToolkitCantModify- The dimension isn't modifiable.

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

Parameters:

Prefix

Returns:

GetSuffix

/*optional*/ String GetSuffix ()

Exceptions thrown (but not limited to):

XToolkitInvalidType- The dimension type is invalid.

XToolkitNotFound- The dimension or suffix is not found.

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

Returns:

SetSuffix

void SetSuffix (String Suffix)

Exceptions thrown (but not limited to):

XToolkitInvalidType- The dimension type is invalid.

XToolkitNotFound- The dimension isn't found.

XToolkitCantModify- The dimension isn't modifiable.

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

Parameters:

Suffix

Returns:

IsToleranceDisplayed

boolean IsToleranceDisplayed ()

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

Returns:

IsBasic

boolean IsBasic ()

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

Returns:

IsInspection

boolean IsInspection ()

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

Returns:

SetAsInspection

void SetAsInspection (boolean Inspection)

Exceptions thrown (but not limited to):

XToolkitCantWrite- 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:

SetAsBasic

void SetAsBasic (boolean Basic)

Exceptions thrown (but not limited to):

XToolkitCantWrite- 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:

GetOwnerFeature

/*optional*/ Feature GetOwnerFeature ()

Exceptions thrown (but not limited to):

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

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

Returns:

GetDisplayedValue

double GetDisplayedValue ()

Exceptions thrown (but not limited to):

XToolkitAmbiguous- The displayed format is not decimal

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

Returns:

GetDisplayedUpperLimitTolerance

/*optional*/ Double GetDisplayedUpperLimitTolerance ()

Exceptions thrown (but not limited to):

XToolkitAmbiguous- The displayed format is not decimal

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

Returns:

GetDisplayedLowerLimitTolerance

/*optional*/ Double GetDisplayedLowerLimitTolerance ()

Exceptions thrown (but not limited to):

XToolkitAmbiguous- The displayed format is not decimal

Manual References:: Dimensions and Parameters: Dimension Tolerances

Returns:

DisplayValueAsRounded

void DisplayValueAsRounded (boolean Value)

Exceptions thrown (but not limited to):

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

XToolkitCantModify- Modification of the attribute is not allowed

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

Parameters:

Value

Returns:

IsDisplayedValueRounded

boolean IsDisplayedValueRounded ()

Exceptions thrown (but not limited to):

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

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

Returns:

GetOverrideValue

/*optional*/ Double GetOverrideValue ()

Exceptions thrown (but not limited to):

XToolkitNotFound- The override value is not set.

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

Returns:

SetOverrideValue

void SetOverrideValue (double Value)

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

Parameters:

Value

Returns:

GetDisplayedValueType

DimValueDisplay GetDisplayedValueType ()

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

Returns:

SetDisplayedValueType

void SetDisplayedValueType (DimValueDisplay DisplayValueType)

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

Parameters:

DisplayValueType

Returns:

SetElbowLength

void SetElbowLength (double ElbowLength, /*optional*/ Drawing Drw)

Exceptions thrown (but not limited to):

XToolkitNotFound- The dimension is not a chamfer dimension.

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

Parameters:

ElbowLength
Drw

Returns:

GetChamferLeaderStyle

/*optional*/ DimChamferLeaderStyle GetChamferLeaderStyle ( /*optional*/ Drawing Drw)

Exceptions thrown (but not limited to):

XToolkitNotFound- 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:

SetChamferLeaderStyle

void SetChamferLeaderStyle (DimChamferLeaderStyle ChamferLeaderStyle, /*optional*/ Drawing Drw)

Exceptions thrown (but not limited to):

XToolkitNotFound- 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:

GetConfiguration

DimLeaderConfig GetConfiguration ( /*optional*/ Drawing Drw)

Obtains the dimension configuration.

Exceptions thrown (but not limited to):

XToolkitNotFound- 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

SetConfiguration

void SetConfiguration (DimLeaderConfig Config, /*optional*/ Drawing 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:

IsSignDriven

boolean 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.

CreateSimpleBreak

void CreateSimpleBreak (Point3D BreakStart, Point3D BreakEnd, int WitnessLineIndex, /*optional*/ Drawing Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

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

XToolkitInvalidItem- The dimension is not valid.

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

XToolkitAbort- 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:

CreateJog

void CreateJog (Point3Ds JogPoints, int WitnessLineIndex, /*optional*/ Drawing Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

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

XToolkitInvalidItem- The dimension is not valid for this operation.

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

XToolkitAbort- 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:

GetDimLocation

DimLocation GetDimLocation ( /*optional*/ Drawing Drawing, /*optional*/ View View)

Exceptions thrown (but not limited to):

XToolkitNotDisplayed- 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.

XToolkitNotFound- This dimension is not displayable.

XToolkitNotValid- A drawing view was passed with a drawing.

Parameters:

Drawing
View

Returns:

GetFirstDimArrowType

LeaderArrowType GetFirstDimArrowType ( /*optional*/ Drawing Drawing, /*optional*/ View 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.

GetSecondDimArrowType

/*optional*/ LeaderArrowType GetSecondDimArrowType ( /*optional*/ Drawing Drawing, /*optional*/ View 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.

Delete

void Delete ()

LICENSE: 222

Exceptions thrown (but not limited to):

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

XToolkitInvalidItem- 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:

IsDriving

boolean IsDriving ()

LICENSE: 222

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

Returns:

SetAnnotationPlane

void SetAnnotationPlane (AnnotationPlane Plane)

LICENSE: 222

Exceptions thrown (but not limited to):

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

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

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

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

Parameters:

Plane

Returns:

GetAnnotationPlane

AnnotationPlane GetAnnotationPlane ()

LICENSE: 222

Manual References:: Dimensions and Parameters: Dimension Orientation

Returns:

Move

void Move (Point3D Location)

LICENSE: 222

Parameters:

Location

Returns:

IsBaseline

boolean IsBaseline ()

LICENSE: 222

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

Returns:

IsAccessibleInModel

boolean IsAccessibleInModel ()

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

Returns:

SetOrdinateStandard

void SetOrdinateStandard (DimOrdinateStandard Standard)

LICENSE: 222

Exceptions thrown (but not limited to):

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

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

Parameters:

Standard

Returns:

GetOrdinateStandard

DimOrdinateStandard GetOrdinateStandard ()

LICENSE: 222

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

Returns:

IsOrdinate

boolean IsOrdinate ()

LICENSE: 222

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

Returns:

GetBaselineDimension

/*optional*/ Dimension GetBaselineDimension ()

LICENSE: 222

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

Returns:

CreateAnnotationElement

/*optional*/ AnnotationElement CreateAnnotationElement (AnnotationPlane Plane)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitInvalidType- The dimension is not a driving dimension.

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

XToolkitFound- The dimension already has an annotation element.

XToolkitInvalidMatrix- 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:

DeleteAnnotationElement

void DeleteAnnotationElement ()

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNotFound- The dimension does not have an annotation element.

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

Returns:

GetChamferStyle

/*optional*/ DimChamferStyle GetChamferStyle ( /*optional*/ Drawing Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNotFound- 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:

SetChamferStyle

void SetChamferStyle (DimChamferStyle ChamferStyle, /*optional*/ Drawing Drawing)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNotFound- The dimension style is not chamfer.

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

Parameters:

ChamferStyle
Drawing

Returns:

GetDimensionAttachPoints

DimensionAttachments GetDimensionAttachPoints ()

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitInvalidItem- 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:

GetDimensionSenses

DimSenses GetDimensionSenses ()

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitInvalidItem- 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:

GetOrientationHint

DimOrientationHint GetOrientationHint ()

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitInvalidItem- 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:

SetDimensionAttachPoints

void SetDimensionAttachPoints (DimensionAttachments DimAttachments, DimSenses DimSenses, DimOrientationHint OrientHint, AnnotationPlane AnnotPlane)

LICENSE: 222

Exceptions thrown (but not limited to):

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

XToolkitCantWrite- 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:

EraseWitnessLine

void EraseWitnessLine (int WitnessLineIndex, /*optional*/ Drawing Drawing)

Exceptions thrown (but not limited to):

XToolkitNoChange- The dimension witnessline could not be erased.

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

Parameters:

WitnessLineIndex
Drawing

Returns:

ShowWitnessLine

void ShowWitnessLine ( /*optional*/ Drawing Drawing)

Exceptions thrown (but not limited to):

XToolkitNoChange- 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:

SetOrdinateReferences

void SetOrdinateReferences (DimensionAttachment DimAttachment, DimSenses DimSenses, DimOrientationHint OrientHint)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitBadDimAttach- Invalid attachment geometry for this ordinate dimension.

XToolkitInvalidType- The dimension is not an ordinate dimension.

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

Parameters:

DimAttachment
DimSenses
OrientHint

Returns:

OrdinateDimensionToLinear

void OrdinateDimensionToLinear ()

LICENSE: 222

Exceptions thrown (but not limited to):

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

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

Returns:

LinearDimensionToOrdinate

void LinearDimensionToOrdinate (Dimension Dimension)

LICENSE: 222

Exceptions thrown (but not limited to):

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

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

Parameters:

Dimension

Returns:

SetDimensionArrowType

void SetDimensionArrowType (int ArrowIndex, LeaderArrowType ArrowType, /*optional*/ Drawing Drawing)

Exceptions thrown (but not limited to):

XToolkitNotFound- The dimension does not exist.

XToolkitInvalidPtr- The dimension owner is invalid.

XToolkitCantModify- The dimension cannot be modified.

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

Parameters:

ArrowIndex
ArrowType
Drawing

Returns:

GetParentDimension

/*optional*/ Dimension GetParentDimension ()

Retrieves the parent dimension of the value dependent dimension.

Returns:: The parent dimension.

GetOriginSide

/*optional*/ Integer GetOriginSide ()

Identify if dimension has an origin side

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

SetOriginSide

void SetOriginSide (int 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:

GetDualOptions

DualDimensionInstructions GetDualOptions ( /*optional*/ Drawing Drw)

Gets the dual dimension display options.

Parameters:

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

Returns:: The dual dimension instructions object.

SetDualOptions

void SetDualOptions ( /*optional*/ Drawing Drw, DualDimensionInstructions 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:

GetDisplayFormat

DimensionDisplayFormat GetDisplayFormat ()

Get display format of dimension.

Returns:: The dimension display format type.

SetDisplayFormat

void SetDisplayFormat (DimensionDisplayFormat Format)

Set display format of dimension.

Parameters:

Format: The dimension display format type.

Returns:

GetAdditionalReferences

AnnotationReferences GetAdditionalReferences (DimensionReferenceType RefType)

Get dimension references.

Parameters:

RefType: The type of dimension reference.

Returns:: Sequence of additional references.

AddAdditionalReferences

void AddAdditionalReferences (DimensionReferenceType RefType, AnnotationReferences Refs)

Add dimension references.

Parameters:

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

Returns:

DeleteAdditionalReferences

void DeleteAdditionalReferences (DimensionReferenceType RefType, int 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 WDimension.GetAdditionalReferences(DimensionReferenceType).

Returns:

GetEnvelope

Envelope3D GetEnvelope ( /*optional*/ Drawing Drawing, int 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):

XToolkitNotFound- 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.