OpenCascade.jsXCAFDimTolObjects
OCCT package XCAFDimTolObjects: XCAFDimTolObjects_AngularQualifier, XCAFDimTolObjects_DatumModifWithValue, XCAFDimTolObjects_DatumObject,…
XCAFDimTolObjects_AngularQualifier
Properties(4)
XCAFDimTolObjects_DatumModifWithValue
Properties(5)
- XCAFDimTolObjects_DatumModifWithValue_CircularOrCylindrical:'XCAFDimTolObjects_DatumModifWithValue_CircularOrCylindrical'readonly
- XCAFDimTolObjects_DatumModifWithValue_Distance:'XCAFDimTolObjects_DatumModifWithValue_Distance'readonly
- XCAFDimTolObjects_DatumModifWithValue_Projected:'XCAFDimTolObjects_DatumModifWithValue_Projected'readonly
- XCAFDimTolObjects_DatumModifWithValue_Spherical:'XCAFDimTolObjects_DatumModifWithValue_Spherical'readonly
XCAFDimTolObjects_DatumObject
Access object to store datum.
Constructors(2)
- Parameters (1)
theObj
Static methods(2)
- get_type_name(): string
Instance methods(39)
Returns semantic name.
- SetSemanticName(theName: TCollection_HAsciiString): void
Sets semantic name.
Parameters (1)theName
Returns datum name.
- SetName(theTag: TCollection_HAsciiString): void
Sets datum name.
Parameters (1)theTag
Returns a sequence of modifiers of the datum.
- SetModifiers(theModifiers: NCollection_Sequence_XCAFDimTolObjects_DatumSingleModif): void
Sets new sequence of datum modifiers.
Parameters (1)theModifiers
- GetModifierWithValue(theModifier: XCAFDimTolObjects_DatumModifWithValue, theValue: number): { theModifier: XCAFDimTolObjects_DatumModifWithValue; theValue: number }
Retrieves datum modifier with value.
Parameters (2)theModifiertheValue
ReturnsA result object with fields:
theModifier: updated value from the call.theValue: updated value from the call.
- SetModifierWithValue(theModifier: XCAFDimTolObjects_DatumModifWithValue, theValue: number): void
Sets datum modifier with value.
Parameters (2)theModifiertheValue
- AddModifier(theModifier: XCAFDimTolObjects_DatumSingleModif): void
Adds a modifier to the datum sequence of modifiers.
Parameters (1)theModifier
Returns datum target shape.
- SetDatumTarget(theShape: TopoDS_Shape): void
Sets datum target shape.
Parameters (1)theShape
- GetPosition(): number
Returns datum position in the related geometric tolerance object.
- SetPosition(thePosition: number): void
Sets datum position in the related geometric tolerance object.
Parameters (1)thePosition
- IsDatumTarget(): boolean
Returns True if the datum target is specified.
- IsDatumTarget(theIsDT: boolean): void
Sets or drops the datum target indicator.
Parameters (1)theIsDT
Returns datum target type.
- SetDatumTargetType(theType: XCAFDimTolObjects_DatumTargetType): void
Sets datum target to point, line, rectangle, circle or area type.
Parameters (1)theType
Returns datum target axis. The Z axis of the datum placement denotes the normal of the surface pointing away from the material.
- SetDatumTargetAxis(theAxis: gp_Ax2): void
Sets datum target axis.
Parameters (1)theAxis
- GetDatumTargetLength(): number
Returns datum target length for line and rectangle types. The length along the X axis of the datum placement.
- SetDatumTargetLength(theLength: number): void
Sets datum target length.
Parameters (1)theLength
- GetDatumTargetWidth(): number
Returns datum target width for rectangle type. The width along the derived Y axis, with the placement itself positioned at the centre of the rectangle.
- SetDatumTargetWidth(theWidth: number): void
Sets datum target width.
Parameters (1)theWidth
- GetDatumTargetNumber(): number
Returns datum target number.
- SetDatumTargetNumber(theNumber: number): void
Sets datum target number.
Parameters (1)theNumber
Sets annotation plane.
Parameters (1)thePlane
Returns annotation plane.
Sets a point on the datum target shape.
Parameters (1)thePnt
Gets point on the datum shape.
- SetPointTextAttach(thePntText: gp_Pnt): void
Sets a position of the datum text.
Parameters (1)thePntText
Gets datum text position.
- HasPlane(): boolean
Returns True if the datum has annotation plane.
- HasPoint(): boolean
Returns True if point on the datum target is specified.
- HasPointText(): boolean
Returns True if the datum text position is specified.
- SetPresentation(thePresentation: TopoDS_Shape, thePresentationName: TCollection_HAsciiString): void
Set graphical presentation for object.
Parameters (2)thePresentationthePresentationName
Returns graphical presentation of the object.
Returns graphical presentation of the object.
- HasDatumTargetParams(): boolean
Returns True if the datum has valid parameters for datum target (width, length, circle radius etc).
XCAFDimTolObjects_DatumSingleModif
Properties(22)
- XCAFDimTolObjects_DatumSingleModif_AnyCrossSection:'XCAFDimTolObjects_DatumSingleModif_AnyCrossSection'readonly
- XCAFDimTolObjects_DatumSingleModif_Any_LongitudinalSection:'XCAFDimTolObjects_DatumSingleModif_Any_LongitudinalSection'readonly
- XCAFDimTolObjects_DatumSingleModif_ContactingFeature:'XCAFDimTolObjects_DatumSingleModif_ContactingFeature'readonly
- XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintU:'XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintU'readonly
- XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintV:'XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintV'readonly
- XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintW:'XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintW'readonly
- XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintX:'XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintX'readonly
- XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintY:'XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintY'readonly
- XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintZ:'XCAFDimTolObjects_DatumSingleModif_DegreeOfFreedomConstraintZ'readonly
- XCAFDimTolObjects_DatumSingleModif_DistanceVariable:'XCAFDimTolObjects_DatumSingleModif_DistanceVariable'readonly
- XCAFDimTolObjects_DatumSingleModif_LeastMaterialRequirement:'XCAFDimTolObjects_DatumSingleModif_LeastMaterialRequirement'readonly
- XCAFDimTolObjects_DatumSingleModif_MajorDiameter:'XCAFDimTolObjects_DatumSingleModif_MajorDiameter'readonly
- XCAFDimTolObjects_DatumSingleModif_MaximumMaterialRequirement:'XCAFDimTolObjects_DatumSingleModif_MaximumMaterialRequirement'readonly
- XCAFDimTolObjects_DatumSingleModif_MinorDiameter:'XCAFDimTolObjects_DatumSingleModif_MinorDiameter'readonly
- XCAFDimTolObjects_DatumSingleModif_Orientation:'XCAFDimTolObjects_DatumSingleModif_Orientation'readonly
- XCAFDimTolObjects_DatumSingleModif_PitchDiameter:'XCAFDimTolObjects_DatumSingleModif_PitchDiameter'readonly
- XCAFDimTolObjects_DatumSingleModif_Translation:'XCAFDimTolObjects_DatumSingleModif_Translation'readonly
XCAFDimTolObjects_DatumTargetType
Properties(5)
XCAFDimTolObjects_DimensionFormVariance
Properties(29)
XCAFDimTolObjects_DimensionGrade
Properties(20)
XCAFDimTolObjects_DimensionModif
Properties(24)
- XCAFDimTolObjects_DimensionModif_ControlledRadius:'XCAFDimTolObjects_DimensionModif_ControlledRadius'readonly
- XCAFDimTolObjects_DimensionModif_StatisticalTolerance:'XCAFDimTolObjects_DimensionModif_StatisticalTolerance'readonly
- XCAFDimTolObjects_DimensionModif_ContinuousFeature:'XCAFDimTolObjects_DimensionModif_ContinuousFeature'readonly
- XCAFDimTolObjects_DimensionModif_TwoPointSize:'XCAFDimTolObjects_DimensionModif_TwoPointSize'readonly
- XCAFDimTolObjects_DimensionModif_LocalSizeDefinedBySphere:'XCAFDimTolObjects_DimensionModif_LocalSizeDefinedBySphere'readonly
- XCAFDimTolObjects_DimensionModif_LeastSquaresAssociationCriterion:'XCAFDimTolObjects_DimensionModif_LeastSquaresAssociationCriterion'readonly
- XCAFDimTolObjects_DimensionModif_MaximumInscribedAssociation:'XCAFDimTolObjects_DimensionModif_MaximumInscribedAssociation'readonly
- XCAFDimTolObjects_DimensionModif_MinimumCircumscribedAssociation:'XCAFDimTolObjects_DimensionModif_MinimumCircumscribedAssociation'readonly
- XCAFDimTolObjects_DimensionModif_CircumferenceDiameter:'XCAFDimTolObjects_DimensionModif_CircumferenceDiameter'readonly
- XCAFDimTolObjects_DimensionModif_AreaDiameter:'XCAFDimTolObjects_DimensionModif_AreaDiameter'readonly
- XCAFDimTolObjects_DimensionModif_VolumeDiameter:'XCAFDimTolObjects_DimensionModif_VolumeDiameter'readonly
- XCAFDimTolObjects_DimensionModif_MidRangeSize:'XCAFDimTolObjects_DimensionModif_MidRangeSize'readonly
- XCAFDimTolObjects_DimensionModif_RangeOfSizes:'XCAFDimTolObjects_DimensionModif_RangeOfSizes'readonly
- XCAFDimTolObjects_DimensionModif_AnyRestrictedPortionOfFeature:'XCAFDimTolObjects_DimensionModif_AnyRestrictedPortionOfFeature'readonly
- XCAFDimTolObjects_DimensionModif_AnyCrossSection:'XCAFDimTolObjects_DimensionModif_AnyCrossSection'readonly
- XCAFDimTolObjects_DimensionModif_SpecificFixedCrossSection:'XCAFDimTolObjects_DimensionModif_SpecificFixedCrossSection'readonly
- XCAFDimTolObjects_DimensionModif_CommonTolerance:'XCAFDimTolObjects_DimensionModif_CommonTolerance'readonly
- XCAFDimTolObjects_DimensionModif_FreeStateCondition:'XCAFDimTolObjects_DimensionModif_FreeStateCondition'readonly
XCAFDimTolObjects_DimensionObject
Access object to store dimension data.
Constructors(2)
- Parameters (1)
theObj
Static methods(4)
- IsDimensionalLocation(theType: XCAFDimTolObjects_DimensionType): boolean
Returns true if the dimension type is a location.
Parameters (1)theType
- IsDimensionalSize(theType: XCAFDimTolObjects_DimensionType): boolean
Returns true if the dimension type is a size.
Parameters (1)theType
- get_type_name(): string
Instance methods(68)
Returns semantic name.
- SetSemanticName(theName: TCollection_HAsciiString): void
Sets semantic name.
Parameters (1)theName
- SetQualifier(theQualifier: XCAFDimTolObjects_DimensionQualifier): void
Sets dimension qualifier as min., max. or average.
Parameters (1)theQualifier
Returns dimension qualifier.
- HasQualifier(): boolean
Returns True if the object has dimension qualifier.
- SetAngularQualifier(theAngularQualifier: XCAFDimTolObjects_AngularQualifier): void
Sets angular qualifier as small, large or equal.
Parameters (1)theAngularQualifier
Returns angular qualifier.
- HasAngularQualifier(): boolean
Returns True if the object has angular qualifier.
- SetType(theTyupe: XCAFDimTolObjects_DimensionType): void
Sets a specific type of dimension.
Parameters (1)theTyupe
Returns dimension type.
- GetValue(): number
Returns the main dimension value. It will be the middle value in case of range dimension.
Returns raw array of dimension values.
- SetValue(theValue: number): void
Sets the main dimension value. Overwrites previous values.
Parameters (1)theValue
- SetValues(theValue: NCollection_HArray1_double): void
Replaces current raw array of dimension values with theValues array.
Parameters (1)theValue
- IsDimWithRange(): boolean
Returns True if the dimension is of range kind. Dimension is of range kind if its values array contains two elements defining lower and upper bounds.
- SetUpperBound(theUpperBound: number): void
Sets the upper bound of the range dimension, otherwise resets it to an empty range with the specified upper bound.
Parameters (1)theUpperBound
- SetLowerBound(theLowerBound: number): void
Sets the lower bound of the range dimension, otherwise resets it to an empty range with the specified lower bound.
Parameters (1)theLowerBound
- GetUpperBound(): number
Returns the upper bound of the range dimension, otherwise - zero.
- GetLowerBound(): number
Returns the lower bound of the range dimension, otherwise - zero.
- IsDimWithPlusMinusTolerance(): boolean
Returns True if the dimension is of +/- tolerance kind. Dimension is of +/- tolerance kind if its values array contains three elements defining the main value and the lower/upper tolerances.
- SetUpperTolValue(theUperTolValue: number): boolean
Sets the upper value of the toleranced dimension, otherwise resets a simple dimension to toleranced one with the specified lower/upper tolerances. Returns False in case of range dimension.
Parameters (1)theUperTolValue
- SetLowerTolValue(theLowerTolValue: number): boolean
Sets the lower value of the toleranced dimension, otherwise resets a simple dimension to toleranced one with the specified lower/upper tolerances. Returns False in case of range dimension.
Parameters (1)theLowerTolValue
- GetUpperTolValue(): number
Returns the lower value of the toleranced dimension, otherwise - zero.
- GetLowerTolValue(): number
Returns the upper value of the toleranced dimension, otherwise - zero.
- IsDimWithClassOfTolerance(): boolean
Returns True if the form variance was set to not XCAFDimTolObjects_DimensionFormVariance_None value.
- SetClassOfTolerance(theHole: boolean, theFormVariance: XCAFDimTolObjects_DimensionFormVariance, theGrade: XCAFDimTolObjects_DimensionGrade): void
Sets tolerance class of the dimension.
Parameters (3)theHole—- True if the tolerance applies to an internal feature
theFormVariance—- represents the fundamental deviation or "position letter" of the ISO 286 limits-and-fits tolerance classification.
theGrade—- represents the quality or the accuracy grade of a tolerance.
- GetClassOfTolerance(theHole: boolean, theFormVariance: XCAFDimTolObjects_DimensionFormVariance, theGrade: XCAFDimTolObjects_DimensionGrade): { returnValue: boolean; theHole: boolean; theFormVariance: XCAFDimTolObjects_DimensionFormVariance; theGrade: XCAFDimTolObjects_DimensionGrade }
Retrieves tolerance class parameters of the dimension. Returns True if the dimension is toleranced.
Parameters (3)theHoletheFormVariancetheGrade
ReturnsA result object with fields:
returnValue: the C++ return valuetheHole: updated value from the call.theFormVariance: updated value from the call.theGrade: updated value from the call.
- SetNbOfDecimalPlaces(theL: number, theR: number): void
Sets the number of places to the left and right of the decimal point respectively.
Parameters (2)theLtheR
- GetNbOfDecimalPlaces(theL: number, theR: number): { theL: number; theR: number }
Returns the number of places to the left and right of the decimal point respectively.
Parameters (2)theLtheR
ReturnsA result object with fields:
theL: updated value from the call.theR: updated value from the call.
Returns a sequence of modifiers of the dimension.
- SetModifiers(theModifiers: NCollection_Sequence_XCAFDimTolObjects_DimensionModif): void
Sets new sequence of dimension modifiers.
Parameters (1)theModifiers
- AddModifier(theModifier: XCAFDimTolObjects_DimensionModif): void
Adds a modifier to the dimension sequence of modifiers.
Parameters (1)theModifier
Returns a 'curve' along which the dimension is measured.
- SetPath(thePath: TopoDS_Edge): void
Sets a 'curve' along which the dimension is measured.
Parameters (1)thePath
- GetDirection(theDir: gp_Dir): boolean
Returns the orientation of the dimension in annotation plane.
Parameters (1)theDir—Mutated in place; read the updated value from this argument after the call.
- SetDirection(theDir: gp_Dir): boolean
Sets an orientation of the dimension in annotation plane.
Parameters (1)theDir
- SetPointTextAttach(thePntText: gp_Pnt): void
Sets position of the dimension text.
Parameters (1)thePntText
Returns position of the dimension text.
- HasTextPoint(): boolean
Returns True if the position of dimension text is specified.
Sets annotation plane.
Parameters (1)thePlane
Returns annotation plane.
- HasPlane(): boolean
Returns True if the object has annotation plane.
- HasPoint(): boolean
Returns true, if connection point exists (for dimensional_size), if connection point for the first shape exists (for dimensional_location).
- HasPoint2(): boolean
- IsPointConnection(): boolean
Returns true, if the connection is a point not coordinate system (for dimensional_size), if connection point for the first shape exists (for dimensional_location).
- IsPointConnection2(): boolean
Set connection point (for dimensional_size), Set connection point for the first shape (for dimensional_location).
Parameters (1)thePnt
- Parameters (1)
thePnt
- SetConnectionAxis(theAxis: gp_Ax2): void
Set connection point as a coordinate system (for dimensional_size), Set connection point as a coordinate system for the first shape (for dimensional_location).
Parameters (1)theAxis
- SetConnectionAxis2(theAxis: gp_Ax2): voidParameters (1)
theAxis
Get connection point (for dimensional_size), Get connection point for the first shape (for dimensional_location).
Get connection point as a coordinate system (for dimensional_size), Get connection point as a coordinate system for the first shape (for dimensional_location).
Returns connection name of the object.
Returns 2nd connection name of the object.
- SetConnectionName(theName: TCollection_HAsciiString): void
Sets connection name of the object.
Parameters (1)theName
- SetConnectionName2(theName: TCollection_HAsciiString): void
Sets 2nd connection name of the object.
Parameters (1)theName
- SetPresentation(thePresentation: TopoDS_Shape, thePresentationName: TCollection_HAsciiString): void
Set graphical presentation for the object.
Parameters (2)thePresentationthePresentationName
Returns graphical presentation of the object.
Returns graphical presentation of the object.
- HasDescriptions(): boolean
Returns true, if the object has descriptions.
- NbDescriptions(): number
Returns number of descriptions.
- GetDescription(theNumber: number): TCollection_HAsciiString
Returns description with the given number.
Parameters (1)theNumber
- GetDescriptionName(theNumber: number): TCollection_HAsciiString
Returns name of description with the given number.
Parameters (1)theNumber
- RemoveDescription(theNumber: number): void
Remove description with the given number.
Parameters (1)theNumber
- AddDescription(theDescription: TCollection_HAsciiString, theName: TCollection_HAsciiString): void
Add new description.
Parameters (2)theDescriptiontheName
XCAFDimTolObjects_DimensionQualifier
Properties(4)
XCAFDimTolObjects_DimensionType
Properties(32)
- XCAFDimTolObjects_DimensionType_Location_None:'XCAFDimTolObjects_DimensionType_Location_None'readonly
- XCAFDimTolObjects_DimensionType_Location_CurvedDistance:'XCAFDimTolObjects_DimensionType_Location_CurvedDistance'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance:'XCAFDimTolObjects_DimensionType_Location_LinearDistance'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromCenterToOuter:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromCenterToOuter'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromCenterToInner:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromCenterToInner'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromOuterToCenter:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromOuterToCenter'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromOuterToOuter:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromOuterToOuter'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromOuterToInner:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromOuterToInner'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromInnerToCenter:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromInnerToCenter'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromInnerToOuter:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromInnerToOuter'readonly
- XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromInnerToInner:'XCAFDimTolObjects_DimensionType_Location_LinearDistance_FromInnerToInner'readonly
- XCAFDimTolObjects_DimensionType_Location_Angular:'XCAFDimTolObjects_DimensionType_Location_Angular'readonly
- XCAFDimTolObjects_DimensionType_Location_Oriented:'XCAFDimTolObjects_DimensionType_Location_Oriented'readonly
- XCAFDimTolObjects_DimensionType_Location_WithPath:'XCAFDimTolObjects_DimensionType_Location_WithPath'readonly
- XCAFDimTolObjects_DimensionType_Size_CurveLength:'XCAFDimTolObjects_DimensionType_Size_CurveLength'readonly
- XCAFDimTolObjects_DimensionType_Size_Diameter:'XCAFDimTolObjects_DimensionType_Size_Diameter'readonly
- XCAFDimTolObjects_DimensionType_Size_SphericalDiameter:'XCAFDimTolObjects_DimensionType_Size_SphericalDiameter'readonly
- XCAFDimTolObjects_DimensionType_Size_SphericalRadius:'XCAFDimTolObjects_DimensionType_Size_SphericalRadius'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalMinorDiameter:'XCAFDimTolObjects_DimensionType_Size_ToroidalMinorDiameter'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalMajorDiameter:'XCAFDimTolObjects_DimensionType_Size_ToroidalMajorDiameter'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalMinorRadius:'XCAFDimTolObjects_DimensionType_Size_ToroidalMinorRadius'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalMajorRadius:'XCAFDimTolObjects_DimensionType_Size_ToroidalMajorRadius'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalHighMajorDiameter:'XCAFDimTolObjects_DimensionType_Size_ToroidalHighMajorDiameter'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalLowMajorDiameter:'XCAFDimTolObjects_DimensionType_Size_ToroidalLowMajorDiameter'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalHighMajorRadius:'XCAFDimTolObjects_DimensionType_Size_ToroidalHighMajorRadius'readonly
- XCAFDimTolObjects_DimensionType_Size_ToroidalLowMajorRadius:'XCAFDimTolObjects_DimensionType_Size_ToroidalLowMajorRadius'readonly
- XCAFDimTolObjects_DimensionType_Size_Thickness:'XCAFDimTolObjects_DimensionType_Size_Thickness'readonly
- XCAFDimTolObjects_DimensionType_Size_WithPath:'XCAFDimTolObjects_DimensionType_Size_WithPath'readonly
- XCAFDimTolObjects_DimensionType_DimensionPresentation:'XCAFDimTolObjects_DimensionType_DimensionPresentation'readonly
XCAFDimTolObjects_GeomToleranceMatReqModif
Properties(3)
- XCAFDimTolObjects_GeomToleranceMatReqModif_None:'XCAFDimTolObjects_GeomToleranceMatReqModif_None'readonly
XCAFDimTolObjects_GeomToleranceModif
Properties(17)
- XCAFDimTolObjects_GeomToleranceModif_Any_Cross_Section:'XCAFDimTolObjects_GeomToleranceModif_Any_Cross_Section'readonly
- XCAFDimTolObjects_GeomToleranceModif_Common_Zone:'XCAFDimTolObjects_GeomToleranceModif_Common_Zone'readonly
- XCAFDimTolObjects_GeomToleranceModif_Each_Radial_Element:'XCAFDimTolObjects_GeomToleranceModif_Each_Radial_Element'readonly
- XCAFDimTolObjects_GeomToleranceModif_Free_State:'XCAFDimTolObjects_GeomToleranceModif_Free_State'readonly
- XCAFDimTolObjects_GeomToleranceModif_Least_Material_Requirement:'XCAFDimTolObjects_GeomToleranceModif_Least_Material_Requirement'readonly
- XCAFDimTolObjects_GeomToleranceModif_Line_Element:'XCAFDimTolObjects_GeomToleranceModif_Line_Element'readonly
- XCAFDimTolObjects_GeomToleranceModif_Major_Diameter:'XCAFDimTolObjects_GeomToleranceModif_Major_Diameter'readonly
- XCAFDimTolObjects_GeomToleranceModif_Maximum_Material_Requirement:'XCAFDimTolObjects_GeomToleranceModif_Maximum_Material_Requirement'readonly
- XCAFDimTolObjects_GeomToleranceModif_Minor_Diameter:'XCAFDimTolObjects_GeomToleranceModif_Minor_Diameter'readonly
- XCAFDimTolObjects_GeomToleranceModif_Not_Convex:'XCAFDimTolObjects_GeomToleranceModif_Not_Convex'readonly
- XCAFDimTolObjects_GeomToleranceModif_Pitch_Diameter:'XCAFDimTolObjects_GeomToleranceModif_Pitch_Diameter'readonly
- XCAFDimTolObjects_GeomToleranceModif_Reciprocity_Requirement:'XCAFDimTolObjects_GeomToleranceModif_Reciprocity_Requirement'readonly
- XCAFDimTolObjects_GeomToleranceModif_Separate_Requirement:'XCAFDimTolObjects_GeomToleranceModif_Separate_Requirement'readonly
- XCAFDimTolObjects_GeomToleranceModif_Statistical_Tolerance:'XCAFDimTolObjects_GeomToleranceModif_Statistical_Tolerance'readonly
- XCAFDimTolObjects_GeomToleranceModif_Tangent_Plane:'XCAFDimTolObjects_GeomToleranceModif_Tangent_Plane'readonly
- XCAFDimTolObjects_GeomToleranceModif_All_Around:'XCAFDimTolObjects_GeomToleranceModif_All_Around'readonly
- XCAFDimTolObjects_GeomToleranceModif_All_Over:'XCAFDimTolObjects_GeomToleranceModif_All_Over'readonly
XCAFDimTolObjects_GeomToleranceObject
Access object to store dimension and tolerance.
Constructors(2)
- Parameters (1)
theObj
Static methods(2)
- get_type_name(): string
Instance methods(41)
Returns semantic name.
- SetSemanticName(theName: TCollection_HAsciiString): void
Sets semantic name.
Parameters (1)theName
- SetType(theType: XCAFDimTolObjects_GeomToleranceType): void
Sets type of the object.
Parameters (1)theType
Returns type of the object.
- SetTypeOfValue(theTypeOfValue: XCAFDimTolObjects_GeomToleranceTypeValue): void
Sets type of tolerance value.
Parameters (1)theTypeOfValue
Returns type of tolerance value.
- SetValue(theValue: number): void
Sets tolerance value.
Parameters (1)theValue
- GetValue(): number
Returns tolerance value.
- SetMaterialRequirementModifier(theMatReqModif: XCAFDimTolObjects_GeomToleranceMatReqModif): void
Sets material requirement of the tolerance.
Parameters (1)theMatReqModif
Returns material requirement of the tolerance.
- SetZoneModifier(theZoneModif: XCAFDimTolObjects_GeomToleranceZoneModif): void
Sets tolerance zone.
Parameters (1)theZoneModif
Returns tolerance zone.
- SetValueOfZoneModifier(theValue: number): void
Sets value associated with tolerance zone.
Parameters (1)theValue
- GetValueOfZoneModifier(): number
Returns value associated with tolerance zone.
- SetModifiers(theModifiers: NCollection_Sequence_XCAFDimTolObjects_GeomToleranceModif): void
Sets new sequence of tolerance modifiers.
Parameters (1)theModifiers
- AddModifier(theModifier: XCAFDimTolObjects_GeomToleranceModif): void
Adds a tolerance modifier to the sequence of modifiers.
Parameters (1)theModifier
Returns a sequence of modifiers of the tolerance.
- SetMaxValueModifier(theModifier: number): void
Sets the maximal upper tolerance value for tolerance with modifiers.
Parameters (1)theModifier
- GetMaxValueModifier(): number
Returns the maximal upper tolerance.
- Parameters (1)
theAxis
- HasAxis(): boolean
Sets annotation plane.
Parameters (1)thePlane
Returns annotation plane.
Sets reference point.
Parameters (1)thePnt
Returns reference point.
- SetPointTextAttach(thePntText: gp_Pnt): void
Sets text position.
Parameters (1)thePntText
Returns the text position.
- HasPlane(): boolean
Returns True if the object has annotation plane.
- HasPoint(): boolean
Returns True if reference point is specified.
- HasPointText(): boolean
Returns True if text position is specified.
- SetPresentation(thePresentation: TopoDS_Shape, thePresentationName: TCollection_HAsciiString): void
Set graphical presentation for object.
Parameters (2)thePresentationthePresentationName
Returns graphical presentation of the object.
Returns graphical presentation of the object.
- HasAffectedPlane(): boolean
- SetAffectedPlaneType(theType: XCAFDimTolObjects_ToleranceZoneAffectedPlane): voidParameters (1)
theType
- SetAffectedPlane(thePlane: gp_Pln): void
Sets affected plane.
Parameters (1)thePlane
- SetAffectedPlane(thePlane: gp_Pln, theType: XCAFDimTolObjects_ToleranceZoneAffectedPlane): void
Sets affected plane.
Parameters (2)thePlanetheType
Returns affected plane.
XCAFDimTolObjects_GeomToleranceType
Properties(16)
- XCAFDimTolObjects_GeomToleranceType_Angularity:'XCAFDimTolObjects_GeomToleranceType_Angularity'readonly
- XCAFDimTolObjects_GeomToleranceType_CircularRunout:'XCAFDimTolObjects_GeomToleranceType_CircularRunout'readonly
- XCAFDimTolObjects_GeomToleranceType_CircularityOrRoundness:'XCAFDimTolObjects_GeomToleranceType_CircularityOrRoundness'readonly
- XCAFDimTolObjects_GeomToleranceType_Coaxiality:'XCAFDimTolObjects_GeomToleranceType_Coaxiality'readonly
- XCAFDimTolObjects_GeomToleranceType_Concentricity:'XCAFDimTolObjects_GeomToleranceType_Concentricity'readonly
- XCAFDimTolObjects_GeomToleranceType_Cylindricity:'XCAFDimTolObjects_GeomToleranceType_Cylindricity'readonly
- XCAFDimTolObjects_GeomToleranceType_Parallelism:'XCAFDimTolObjects_GeomToleranceType_Parallelism'readonly
- XCAFDimTolObjects_GeomToleranceType_Perpendicularity:'XCAFDimTolObjects_GeomToleranceType_Perpendicularity'readonly
- XCAFDimTolObjects_GeomToleranceType_ProfileOfLine:'XCAFDimTolObjects_GeomToleranceType_ProfileOfLine'readonly
- XCAFDimTolObjects_GeomToleranceType_ProfileOfSurface:'XCAFDimTolObjects_GeomToleranceType_ProfileOfSurface'readonly
- XCAFDimTolObjects_GeomToleranceType_Straightness:'XCAFDimTolObjects_GeomToleranceType_Straightness'readonly
- XCAFDimTolObjects_GeomToleranceType_TotalRunout:'XCAFDimTolObjects_GeomToleranceType_TotalRunout'readonly
XCAFDimTolObjects_GeomToleranceTypeValue
Properties(3)
- XCAFDimTolObjects_GeomToleranceTypeValue_None:'XCAFDimTolObjects_GeomToleranceTypeValue_None'readonly
- XCAFDimTolObjects_GeomToleranceTypeValue_Diameter:'XCAFDimTolObjects_GeomToleranceTypeValue_Diameter'readonly
- XCAFDimTolObjects_GeomToleranceTypeValue_SphericalDiameter:'XCAFDimTolObjects_GeomToleranceTypeValue_SphericalDiameter'readonly
XCAFDimTolObjects_GeomToleranceZoneModif
Properties(4)
- XCAFDimTolObjects_GeomToleranceZoneModif_None:'XCAFDimTolObjects_GeomToleranceZoneModif_None'readonly
- XCAFDimTolObjects_GeomToleranceZoneModif_Projected:'XCAFDimTolObjects_GeomToleranceZoneModif_Projected'readonly
- XCAFDimTolObjects_GeomToleranceZoneModif_Runout:'XCAFDimTolObjects_GeomToleranceZoneModif_Runout'readonly
- XCAFDimTolObjects_GeomToleranceZoneModif_NonUniform:'XCAFDimTolObjects_GeomToleranceZoneModif_NonUniform'readonly
XCAFDimTolObjects_ToleranceZoneAffectedPlane
Properties(3)
- XCAFDimTolObjects_ToleranceZoneAffectedPlane_None:'XCAFDimTolObjects_ToleranceZoneAffectedPlane_None'readonly
- XCAFDimTolObjects_ToleranceZoneAffectedPlane_Intersection:'XCAFDimTolObjects_ToleranceZoneAffectedPlane_Intersection'readonly
- XCAFDimTolObjects_ToleranceZoneAffectedPlane_Orientation:'XCAFDimTolObjects_ToleranceZoneAffectedPlane_Orientation'readonly
XCAFDimTolObjects_Tool
Constructors(1)
- Parameters (1)
theDoc
Instance methods(5)
- GetDimensions(theDimensionObjectSequence: NCollection_Sequence_handle_XCAFDimTolObjects_DimensionObject): void
Returns a sequence of Dimensions currently stored in the GD&T table.
Parameters (1)theDimensionObjectSequence—Mutated in place; read the updated value from this argument after the call.
- GetRefDimensions(theShape: TopoDS_Shape, theDimensions: NCollection_Sequence_handle_XCAFDimTolObjects_DimensionObject): boolean
Returns all Dimensions defined for Shape.
Parameters (2)theShapetheDimensions—Mutated in place; read the updated value from this argument after the call.
- GetGeomTolerances(theGeomToleranceObjectSequence: NCollection_Sequence_handle_XCAFDimTolObjects_GeomToleranceObject, theDatumObjectSequence: NCollection_Sequence_handle_XCAFDimTolObjects_DatumObject, theMap: NCollection_DataMap_handle_XCAFDimTolObjects_GeomToleranceObject_handle_XCAFDimTolObjects_DatumObject): void
Returns a sequence of Tolerances currently stored in the GD&T table.
Parameters (3)theGeomToleranceObjectSequence—Mutated in place; read the updated value from this argument after the call.theDatumObjectSequence—Mutated in place; read the updated value from this argument after the call.theMap—Mutated in place; read the updated value from this argument after the call.
- GetRefGeomTolerances(theShape: TopoDS_Shape, theGeomToleranceObjectSequence: NCollection_Sequence_handle_XCAFDimTolObjects_GeomToleranceObject, theDatumObjectSequence: NCollection_Sequence_handle_XCAFDimTolObjects_DatumObject, theMap: NCollection_DataMap_handle_XCAFDimTolObjects_GeomToleranceObject_handle_XCAFDimTolObjects_DatumObject): boolean
Returns all GeomTolerances defined for Shape.
Parameters (4)theShapetheGeomToleranceObjectSequence—Mutated in place; read the updated value from this argument after the call.theDatumObjectSequence—Mutated in place; read the updated value from this argument after the call.theMap—Mutated in place; read the updated value from this argument after the call.
- GetRefDatum(theShape: TopoDS_Shape): { returnValue: boolean; theDatum: XCAFDimTolObjects_DatumObject; [Symbol.dispose](): void }
Returns DatumObject defined for Shape.
Parameters (1)theShape
ReturnsA result object with fields:
returnValue: the C++ return valuetheDatum: owned by the returned envelope.
Dispose the returned envelope to release owned Handle fields.