Class pfcBaseDimension
Description
This class defines a base dimension, which can be a dimension or reference dimension.
The dimension types are as follows:
• DIM_LINEAR
• DIM_RADIAL
• DIM_DIAMETER
• DIM_ANGULAR
Direct Parent Classes:
Direct Known Subclasses:
User Guide References:
Property Summary
/* readonly */ pfcDimensionType | |
The dimension type | |
number | |
The value of the dimension. | |
/* readonly */ boolean | |
Identifies if the dimension is currently considered to have a negative "sign" in generating its direction. If the dimension has a negative sign then the dimension is oriented in the opposite manner to the default for the feature. | |
string | |
The dimension name or symbol | |
The dimension text |
Method Summary
void | Erase () |
DEPRECATED: since Creo 4 | |
SUCCESSOR(S): Drawing.EraseDimension | |
void | |
Forces the display of the dimension in a model. |
Property Detail
/* readonly */ pfcDimensionType | DimType |
The dimension type
number | DimValue |
The value of the dimension.
This is always positive if the model is fully regenerated. Use the property pfcBaseDimension.ExtendsInNegativeDirection to detect if the dimension direction is oriented opposite to the feature default. When setting this property, if a negative number is passed, this will flip the direction of the dimension.
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - The input dimension is reference.
/* readonly */ boolean | ExtendsInNegativeDirection |
Identifies if the dimension is currently considered to have a negative "sign" in generating its direction. If the dimension has a negative sign then the dimension is oriented in the opposite manner to the default for the feature.
string | Symbol |
The dimension name or symbol
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - The function could not set the symbol to new value as the new symbol name already exists for other dimension in the model.
Texts |
The dimension text
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - Dimension text is not found.
Method Detail
void | Erase | () |
DEPRECATED: since Creo 4
void | Show |
Forces the display of the dimension in a model.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - The annotation is already shown in the target model.
pfcXToolkitInvalidMatrix - The annotation cannot be shown due to orientation conflicts in the view.
pfcXToolkitNoLicense - License check failure.
pfcXToolkitNotDisplayed - Annotation is present on hidden or blank layer and so can't be shown.
See Also:
Parameters:
Instructions
Specifies the location where the dimension should be shown: Pass null to show the dimension in the top level part or assembly. Pass an instance of pfcComponentDimensionShowInstructions to show the dimension contained in an assembly component in a top level assembly. Pass an instance of pfcDrawingDimensionShowInstructions to show the dimension in a drawing view.