|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
Represents a NXOpen::Annotations::IdSymbol builder
To create a new instance of this class, use NXOpen::Annotations::IdSymbolCollection::CreateIdSymbolBuilder
Default values.
More...
Public Types | |
| enum | SymbolTypes { SymbolTypesCircle, SymbolTypesDividedCircle, SymbolTypesTriangle, SymbolTypesTriangleUp, SymbolTypesSquare, SymbolTypesDividedSquare, SymbolTypesHexagon, SymbolTypesDividedHexagon, SymbolTypesQuadrantCircle, SymbolTypesRoundedBox, SymbolTypesUnderline } |
| the valid types for an id symbol More... | |
Public Member Functions | |
| NXOpen::Annotations::BalloonTypes | BalloonType () |
| Returns the balloon type Created in NX12.0.2. More... | |
| NXOpen::Annotations::ForeshorteningSymbolBuilder * | ForeshorteningSymbol () |
| Returns the foreshortening symbol builder Created in NX10.0.0. More... | |
| NXOpen::SelectObject * | Inherit () |
| Returns the inherit The id symbol from which the style properties are inherited Created in NX5.0.0. More... | |
| NXOpen::Annotations::LeaderBuilder * | Leader () |
| Returns the NXOpen::Annotations::LeaderBuilder for the annotation Created in NX6.0.0. More... | |
| NXString | LowerText () |
| Returns the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line. More... | |
| NXOpen::Annotations::OriginBuilder * | Origin () |
| Returns the origin, where the symbol is going to be displayed Created in NX6.0.0. More... | |
| NXOpen::Annotations::AnnotationPlacement * | Placement () |
| Returns an annotation placement object More... | |
| void | SetBalloonType (NXOpen::Annotations::BalloonTypes type) |
| Sets the balloon type Created in NX12.0.2. More... | |
| void | SetLowerText (const NXString &lowerText) |
| Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line. More... | |
| void | SetLowerText (const char *lowerText) |
| Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line. More... | |
| void | SetPreviewObject (NXOpen::Annotations::IdSymbol *symbol) |
| Sets the preview object for dialog creation of id symbols More... | |
| void | SetSize (double size) |
| Sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle Created in NX5.0.0. More... | |
| void | SetType (NXOpen::Annotations::IdSymbolBuilder::SymbolTypes type) |
| Sets the symbol type More... | |
| void | SetUpperText (const NXString &upperText) |
| Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line. More... | |
| void | SetUpperText (const char *upperText) |
| Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line. More... | |
| double | Size () |
| Returns the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle Created in NX5.0.0. More... | |
| NXOpen::Annotations::StyleBuilder * | Style () |
| Returns the style Created in NX6.0.0. More... | |
| NXOpen::Annotations::IdSymbolBuilder::SymbolTypes | Type () |
| Returns the symbol type More... | |
| NXString | UpperText () |
| Returns the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Represents a NXOpen::Annotations::IdSymbol builder
To create a new instance of this class, use NXOpen::Annotations::IdSymbolCollection::CreateIdSymbolBuilder
Default values.
| Property | Value |
|---|---|
|
Size |
0 |
Created in NX5.0.0.
the valid types for an id symbol
Use NXOpen::Annotations::BalloonTypes instead.
| NXOpen::Annotations::BalloonTypes NXOpen::Annotations::IdSymbolBuilder::BalloonType | ( | ) |
Returns the balloon type
Created in NX12.0.2.
License requirements : None
| NXOpen::Annotations::ForeshorteningSymbolBuilder* NXOpen::Annotations::IdSymbolBuilder::ForeshorteningSymbol | ( | ) |
Returns the foreshortening symbol builder
Created in NX10.0.0.
License requirements : None
| NXOpen::SelectObject* NXOpen::Annotations::IdSymbolBuilder::Inherit | ( | ) |
Returns the inherit The id symbol from which the style properties are inherited
Created in NX5.0.0.
License requirements : None
| NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::IdSymbolBuilder::Leader | ( | ) |
Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.
License requirements : None
| NXString NXOpen::Annotations::IdSymbolBuilder::LowerText | ( | ) |
Returns the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
Created in NX5.0.0.
License requirements : None
| NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::IdSymbolBuilder::Origin | ( | ) |
Returns the origin, where the symbol is going to be displayed
Created in NX6.0.0.
License requirements : None
| NXOpen::Annotations::AnnotationPlacement* NXOpen::Annotations::IdSymbolBuilder::Placement | ( | ) |
Returns an annotation placement object
This functionality is no longer supported.
Created in NX5.0.0.
License requirements : None
| void NXOpen::Annotations::IdSymbolBuilder::SetBalloonType | ( | NXOpen::Annotations::BalloonTypes | type | ) |
Sets the balloon type
Created in NX12.0.2.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| type | type |
| void NXOpen::Annotations::IdSymbolBuilder::SetLowerText | ( | const NXString & | lowerText | ) |
Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
Created in NX5.0.0.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| lowerText | lowertext |
| void NXOpen::Annotations::IdSymbolBuilder::SetLowerText | ( | const char * | lowerText | ) |
Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
Created in NX5.0.0.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| lowerText | lowertext |
| void NXOpen::Annotations::IdSymbolBuilder::SetPreviewObject | ( | NXOpen::Annotations::IdSymbol * | symbol | ) |
Sets the preview object for dialog creation of id symbols
This functionality is no longer supported.
Created in NX5.0.0.
License requirements : None
| symbol | rubberbanding symbol |
| void NXOpen::Annotations::IdSymbolBuilder::SetSize | ( | double | size | ) |
Sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| size | size |
| void NXOpen::Annotations::IdSymbolBuilder::SetType | ( | NXOpen::Annotations::IdSymbolBuilder::SymbolTypes | type | ) |
Sets the symbol type
Use NXOpen::Annotations::IdSymbolBuilder::SetBalloonType instead.
Created in NX6.0.0.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| type | type |
| void NXOpen::Annotations::IdSymbolBuilder::SetUpperText | ( | const NXString & | upperText | ) |
Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
Created in NX5.0.0.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| upperText | uppertext |
| void NXOpen::Annotations::IdSymbolBuilder::SetUpperText | ( | const char * | upperText | ) |
Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
Created in NX5.0.0.
License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")
| upperText | uppertext |
| double NXOpen::Annotations::IdSymbolBuilder::Size | ( | ) |
Returns the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.
License requirements : None
| NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::IdSymbolBuilder::Style | ( | ) |
Returns the style
Created in NX6.0.0.
License requirements : None
| NXOpen::Annotations::IdSymbolBuilder::SymbolTypes NXOpen::Annotations::IdSymbolBuilder::Type | ( | ) |
Returns the symbol type
Use NXOpen::Annotations::IdSymbolBuilder::BalloonType instead.
Created in NX6.0.0.
License requirements : None
| NXString NXOpen::Annotations::IdSymbolBuilder::UpperText | ( | ) |
Returns the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
Created in NX5.0.0.
License requirements : None
