API Documentation > Interfaces > Interface GTol
Interface GTol

package com.ptc.wfc.wfcGTol;

public interface GTol
extends com.ptc.wfc.wfcAnnotation.Annotation


Description
Interface description
User Guide References:
Methods Inherited from Interface com.ptc.wfc.wfcLayerState.LayerItem :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WModelItem :
Methods Inherited from Interface com.ptc.wfc.wfcAnnotation.Annotation :
Method Summary
void
Add gtol references
void
Deletes a gtol from its owning Creo Parametric model.
void
DeleteReference (int RefIndex)
Delete gtol reference
/*cipOptional*/ Envelope3D
Get3DLineEnvelope (int LineNumber)
LICENSE: 222
Get the envelope of a line in a specified geometric tolerance. <p><b>Note:</b> This function only supports gtols which are placed on an annotation plane.
/*cipOptional*/ Point3D
Get the text point location in model co-ordinates from input text position
/*cipOptional*/ AnnotationTextStyle
LICENSE: 222
Gets the text style for the additional text applied to a geometric tolerance.
/*cipOptional*/ String
Obtains the text added to the bottom of the geometric tolerance.
Gets horizontal justification for additional gtol text at the bottom
Get composite tolerance frame
boolean
Get Share datum references for composite frame
Get datum references to gtol.
/*cipOptional*/ DetailNoteItem
GetDetailNote (Drawing DrawingModel)
Return the detail note that represents a shown geometric tolerance.
/*cipOptional*/ GTolElbow
LICENSE: 222
Obtains the elbow properties of the geometric tolerance. <p><b>Note:</b> This function only supports gtols which are placed on an annotation plane.
GetEnvelope ( /*cipOptional*/ Drawing Drawing)
Get the envelope of gtol. For getting coordinates of gtol displayed in solid and same gtol is displayed in drawing then drawing should not be active.
Get Annotation Plane and location from Free type wfcGTol::GTol::GetGTolAttach() leader attachment info. Get datum from gtol AttachGet annotation from gtol AttachGet offset ref from gtol AttachGet make dim information from gtol attachget gtol Attach
/*cipOptional*/ String
Get name of gtol
Set gtol type
Get indicators of gtol
/*cipOptional*/ String
Obtains the text added to the left of the geometric tolerance.
/*cipOptional*/ DetailNoteItems
GetNotes (Drawing Drawing)
Gets the detail notes that represent a geometric tolerance in a drawing.
Get gtol references Note: This function only supports gtols which are not created as Annotation Elements. For Annotation Element Gtol use wfcAnnotation::AnnotationElement::CollectAnnotationReferences().
/*cipOptional*/ String
Retrieves the text of the specified geometrical tolerance.
LICENSE: 222
Get the envelope of the right text in a specified geometric tolerance. <p><b>Note:</b> This function only supports gtols which are placed on an annotation plane.
Get top model of gtol
/*cipOptional*/ String
Obtains the text added to the top of the geometric tolerance.
Gets horizontal justification for additional gtol text at the top
Get Unilateral modifier.
/*cipOptional*/ String
Get value string of gtol
boolean
LICENSE: 222
Get if Additional text to a geometric tolerance with particular wfcGTol::GTolTextType is Boxed. Note that only Top and Bottom wfcGTol::GTolTextType can have Boxed.
boolean
Get all around option for profile gtol
boolean
Get all over option for profile gtol
boolean
Get display of Boundary modifier.
void
SetAddlTextBoxed (GTolTextType Type, boolean IsBoxed)
LICENSE: 222
Set Boxed to Additional text to a geometric tolerance with particular wfcGTol::GTolTextType. Note that only Top and Bottom wfcGTol::GTolTextType can have Boxed.
void
SetAllAround (boolean AllAround)
Set all around option for profile gtol
void
SetAllOver (boolean AllOver)
Set all over option for profile gtol
void
Set annotation related gtol AttachChange gtol Attach
void
Set annotation (pfcITEM_NOTE) related gtol Attach to elbow instead of text
void
Set datum gtol AttachChange gtol Attach
void
Set Free type attachmentChange gtol Attach
void
Set leader type attachmentChange gtol Attach
void
Set make dim type gtol attach Use this function along with ProMdlGtolCreate for creating make-dim type gtol, only in drawing.Change gtol Attach
void
Set offset gtol Attach Use this function along with ProMdlGtolCreate for creating offset type gtol, only in drawing.Change gtol Attach
void
SetBottomText (String BelowText)
Assigns the text added to the bottom of the geometric tolerance.
void
Sets horizontal justification for additional gtol text at the bottom
void
SetBoundaryDisplay (boolean Display)
Set display of Boundary modifier.
void
SetComposite (int Index, GTolComposite Composite)
Set composite tolerance
void
Set Share datum references for composite frame
void
Set datum references to gtol.
void
SetElbow (GTolElbow elbowLength)
LICENSE: 222
Set elbow to gtol. <p><b>Note:</b> This function only supports leader type gtols which are placed on an annotation plane.
void
LICENSE: 222
Sets the text style for the additional text applied to a geometric tolerance. Note that not all text style properties are supported for gtol additional text; unsupported properties are ignored by this function.
void
Set gtol type
void
Set indicators of gtol. Pass types, symbols and dfs as NULL to remove all indicators.
void
SetLeftText (String leftText)
Assigns the text added to the left of the geometric tolerance.
void
SetRightText (String RightText)
Sets the text of the specified geometric tolerance.
void
SetTopText (String TopText)
Assigns the text added to the top of the geometric tolerance.
void
Sets horizontal justification for additional gtol text at the top
void
Set Unilateral modifier.
void
SetValueString (String ValueString)
Set value string of gtol
boolean
Check whether the gtol is valid or not
Method Detail
GetGTolName
/*cipOptional*/ String
GetGTolName
()
Get name of gtol
User Guide References:
Returns:
return description
IsAddlTextBoxed
boolean
IsAddlTextBoxed
(GTolTextType Type)
Get if Additional text to a geometric tolerance with particular wfcGTol::GTolTextType is Boxed. Note that only Top and Bottom wfcGTol::GTolTextType can have Boxed.
User Guide References:
Parameters:
Type
arg description
Returns:
return description
SetAddlTextBoxed
void
SetAddlTextBoxed
(GTolTextType Type, boolean IsBoxed)
Set Boxed to Additional text to a geometric tolerance with particular wfcGTol::GTolTextType. Note that only Top and Bottom wfcGTol::GTolTextType can have Boxed.
User Guide References:
Parameters:
Type
arg description
IsBoxed
arg description
Returns:
IsAllAround
boolean
IsAllAround
()
Get all around option for profile gtol
User Guide References:
Returns:
return description
SetAllAround
void
SetAllAround
(boolean AllAround)
Set all around option for profile gtol
User Guide References:
Parameters:
AllAround
arg description
Returns:
IsAllOver
boolean
IsAllOver
()
Get all over option for profile gtol
User Guide References:
Returns:
return description
SetAllOver
void
SetAllOver
(boolean AllOver)
Set all over option for profile gtol
User Guide References:
Parameters:
AllOver
arg description
Returns:
GetBottomText
/*cipOptional*/ String
GetBottomText
()
Obtains the text added to the bottom of the geometric tolerance.
User Guide References:
Returns:
return description
SetBottomText
void
SetBottomText
(String BelowText)
Assigns the text added to the bottom of the geometric tolerance.
User Guide References:
Parameters:
BelowText
arg description
Returns:
GetBottomTextHorizJustification
GetBottomTextHorizJustification
()
Gets horizontal justification for additional gtol text at the bottom
User Guide References:
Returns:
return description
SetBottomTextHorizJustification
void
SetBottomTextHorizJustification
(HorizontalJustification BottomTextHorizJustification)
Sets horizontal justification for additional gtol text at the bottom
User Guide References:
Parameters:
BottomTextHorizJustification
arg description
Returns:
IsBoundaryDisplay
boolean
IsBoundaryDisplay
()
Get display of Boundary modifier.
User Guide References:
Returns:
return description
SetBoundaryDisplay
void
SetBoundaryDisplay
(boolean Display)
Set display of Boundary modifier.
User Guide References:
Parameters:
Display
Returns:
GetComposite
GetComposite
()
Get composite tolerance frame
User Guide References:
Returns:
return description
SetComposite
void
SetComposite
(int Index, GTolComposite Composite)
Set composite tolerance
User Guide References:
Parameters:
Index
arg description
Composite
arg description
Returns:
GetCompositeSharedReference
boolean
GetCompositeSharedReference
()
Get Share datum references for composite frame
User Guide References:
Returns:
return description
SetCompositeSharedReference
void
SetCompositeSharedReference
(boolean state)
Set Share datum references for composite frame
User Guide References:
Parameters:
state
arg description
Returns:
GetDatumReferences
GetDatumReferences
()
Get datum references to gtol.
User Guide References:
Returns:
return description
SetDatumReferences
void
SetDatumReferences
(GTolDatumReferences datumReferences)
Set datum references to gtol.
User Guide References:
Parameters:
datumReferences
arg description
Returns:
Delete
void
Delete
()
Deletes a gtol from its owning Creo Parametric model.
User Guide References:
Returns:
GetDetailNote
/*cipOptional*/ DetailNoteItem
GetDetailNote
(Drawing DrawingModel)
Return the detail note that represents a shown geometric tolerance.
Parameters:
DrawingModel
arg description
Returns:
return description
User Guide References:
GetElbow
/*cipOptional*/ GTolElbow
GetElbow
()
Obtains the elbow properties of the geometric tolerance. <p><b>Note:</b> This function only supports gtols which are placed on an annotation plane.
User Guide References:
Returns:
return description
SetElbow
void
SetElbow
(GTolElbow elbowLength)
Set elbow to gtol. <p><b>Note:</b> This function only supports leader type gtols which are placed on an annotation plane.
User Guide References:
Parameters:
elbowLength
arg description
Returns:
return description
GetIndicators
GetIndicators
()
Get indicators of gtol
User Guide References:
Returns:
return description
SetIndicators
void
SetIndicators
(GTolIndicators indicators)
Set indicators of gtol. Pass types, symbols and dfs as NULL to remove all indicators.
User Guide References:
Parameters:
indicators
arg description
Returns:
return description
GetLeftText
/*cipOptional*/ String
GetLeftText
()
Obtains the text added to the left of the geometric tolerance.
User Guide References:
Returns:
return description
SetLeftText
void
SetLeftText
(String leftText)
Assigns the text added to the left of the geometric tolerance.
User Guide References:
Parameters:
leftText
arg description
Returns:
Get3DLineEnvelope
/*cipOptional*/ Envelope3D
Get3DLineEnvelope
(int LineNumber)
Get the envelope of a line in a specified geometric tolerance. <p><b>Note:</b> This function only supports gtols which are placed on an annotation plane.
User Guide References:
Parameters:
LineNumber
arg description
Returns:
return description
DeleteReference
void
DeleteReference
(int RefIndex)
Delete gtol reference
User Guide References:
Parameters:
RefIndex
arg description
Returns:
AddReferences
void
AddReferences
(AnnotationReferences References)
Add gtol references
User Guide References:
Parameters:
References
arg description
Returns:
GetReferences
GetReferences
()
Get gtol references Note: This function only supports gtols which are not created as Annotation Elements. For Annotation Element Gtol use wfcAnnotation::AnnotationElement::CollectAnnotationReferences().
User Guide References:
Returns:
return description
GetRightTextEnvelope
GetRightTextEnvelope
()
Get the envelope of the right text in a specified geometric tolerance. <p><b>Note:</b> This function only supports gtols which are placed on an annotation plane.
User Guide References:
Returns:
return description
GetRightText
/*cipOptional*/ String
GetRightText
()
Retrieves the text of the specified geometrical tolerance.
User Guide References:
Returns:
return description
SetRightText
void
SetRightText
(String RightText)
Sets the text of the specified geometric tolerance.
User Guide References:
Parameters:
RightText
arg description
Returns:
GetTopModel
GetTopModel
()
Get top model of gtol
User Guide References:
Returns:
return description
GetTopText
/*cipOptional*/ String
GetTopText
()
Obtains the text added to the top of the geometric tolerance.
User Guide References:
Returns:
return description
SetTopText
void
SetTopText
(String TopText)
Assigns the text added to the top of the geometric tolerance.
User Guide References:
Parameters:
TopText
arg description
Returns:
GetTopTextHorizJustification
GetTopTextHorizJustification
()
Gets horizontal justification for additional gtol text at the top
User Guide References:
Returns:
return description
SetTopTextHorizJustification
void
SetTopTextHorizJustification
(HorizontalJustification TopTextHorizJustification)
Sets horizontal justification for additional gtol text at the top
User Guide References:
Parameters:
TopTextHorizJustification
arg description
Returns:
GetGTolType
GetGTolType
()
Set gtol type
User Guide References:
Returns:
return description
SetGTolType
void
SetGTolType
(GTolType Type)
Set gtol type
User Guide References:
Parameters:
Type
arg description
Returns:
GetValueString
/*cipOptional*/ String
GetValueString
()
Get value string of gtol
User Guide References:
Returns:
return description
SetValueString
void
SetValueString
(String ValueString)
Set value string of gtol
User Guide References:
Parameters:
ValueString
arg description
Returns:
Validate
boolean
Validate
Check whether the gtol is valid or not
User Guide References:
Parameters:
Type
arg description
Returns:
return description
GetUnilateralModifier
GetUnilateralModifier
()
Get Unilateral modifier.
User Guide References:
Returns:
return description
SetUnilateralModifier
void
SetUnilateralModifier
Set Unilateral modifier.
User Guide References:
Parameters:
Modifier
arg description
Returns:
SetGTolAdditionaltextTextStyle
void
SetGTolAdditionaltextTextStyle
(GTolTextType Type, AnnotationTextStyle TextStyle)
Sets the text style for the additional text applied to a geometric tolerance. Note that not all text style properties are supported for gtol additional text; unsupported properties are ignored by this function.
User Guide References:
Parameters:
Type
arg description
TextStyle
arg description
Returns:
GetAdditionaltextTextStyle
/*cipOptional*/ AnnotationTextStyle
GetAdditionaltextTextStyle
(GTolTextType Type)
Gets the text style for the additional text applied to a geometric tolerance.
User Guide References:
Parameters:
Type
arg description
Returns:
return description
GetGTolAttach
GetGTolAttach
()
Get Annotation Plane and location from Free type wfcGTol::GTol::GetGTolAttach() leader attachment info. Get datum from gtol AttachGet annotation from gtol AttachGet offset ref from gtol AttachGet make dim information from gtol attachget gtol Attach
User Guide References:
Returns:
return description
SetAttachFree
void
SetAttachFree
(GTolAttachFree Attach)
Set Free type attachmentChange gtol Attach
User Guide References:
Parameters:
Attach
arg description
Returns:
SetAttachLeader
void
SetAttachLeader
(GTolAttachLeader Attach)
Set leader type attachmentChange gtol Attach
User Guide References:
Parameters:
Attach
arg description
Returns:
SetAttachDatum
void
SetAttachDatum
(GTolAttachDatum Attach)
Set datum gtol AttachChange gtol Attach
User Guide References:
Parameters:
Attach
arg description
Returns:
SetAttachAnnotation
void
SetAttachAnnotation
Set annotation related gtol AttachChange gtol Attach
User Guide References:
Parameters:
Attach
arg description
Returns:
SetAttachOffset
void
SetAttachOffset
(GTolAttachOffset Attach)
Set offset gtol Attach Use this function along with ProMdlGtolCreate for creating offset type gtol, only in drawing.Change gtol Attach
User Guide References:
Parameters:
Attach
arg description
Returns:
SetAttachMakeDimension
void
SetAttachMakeDimension
Set make dim type gtol attach Use this function along with ProMdlGtolCreate for creating make-dim type gtol, only in drawing.Change gtol Attach
User Guide References:
Parameters:
Attach
arg description
Returns:
SetAttachAnnotationElbow
void
SetAttachAnnotationElbow
Set annotation (pfcITEM_NOTE) related gtol Attach to elbow instead of text
Parameters:
Attach
arg description
Returns:
GetNotes
/*cipOptional*/ DetailNoteItems
GetNotes
(Drawing Drawing)
Gets the detail notes that represent a geometric tolerance in a drawing.
User Guide References:
Parameters:
Drawing
The drawing where the note is displayed
Returns:
returns pfcDetailNoteItems_ptr which is optional
GetEnvelope
GetEnvelope
( /*cipOptional*/ Drawing Drawing)
Get the envelope of gtol. For getting coordinates of gtol displayed in solid and same gtol is displayed in drawing then drawing should not be active.
Parameters:
Drawing
drawing. Pass only for solid gtol shown in drawing, otherwise pass NULL.
Returns:
returns wfcEnvelope3D_ptr
GetAdditionalTextLocation
/*cipOptional*/ Point3D
GetAdditionalTextLocation
(GTolTextType Type)
Get the text point location in model co-ordinates from input text position
User Guide References:
Parameters:
Type
Returns:
returns pfcPoint3D_ptr which is optional
Was this helpful?