Represents a NXOpen::Annotations::OriginBuilder
This is a sub-builder class and cannot be directly instantiated
Created in NX6.0.0.
More...
Public Types | |
| enum | AlignmentPosition { AlignmentPositionTopLeft, AlignmentPositionTopCenter, AlignmentPositionTopRight, AlignmentPositionMidLeft, AlignmentPositionMidCenter, AlignmentPositionMidRight, AlignmentPositionBottomLeft, AlignmentPositionBottomCenter, AlignmentPositionBottomRight } |
| alignment position on the annotation More... | |
Public Member Functions | |
| NXOpen::Annotations::OriginBuilder::AlignmentPosition | Anchor () |
| Returns the anchor location of the origin on the annotation Created in NX6.0.0. More... | |
| NXOpen::Drawings::SelectDraftingView * | AnnotationView () |
| Returns the view of the annotation (drafting member views only) Created in NX6.0.0. More... | |
| NXOpen::Annotations::Annotation::AssociativeOriginData | GetAssociativeOrigin () |
| Gets the data that specifies the origin's associativity. More... | |
| NXOpen::SelectDisplayableObject * | Origin () |
| Returns the origin Created in NX6.0.0. More... | |
| NXOpen::Point3d | OriginPoint () |
| Returns the origin point Created in NX6.0.0. More... | |
| NXOpen::Annotations::PlaneBuilder * | Plane () |
| Returns the plane Created in NX6.0.0. More... | |
| void | SetAnchor (NXOpen::Annotations::OriginBuilder::AlignmentPosition anchor) |
| Sets the anchor location of the origin on the annotation Created in NX6.0.0. More... | |
| void | SetAssociativeOrigin (const NXOpen::Annotations::Annotation::AssociativeOriginData &assocOrigin) |
| Associates the annotation's origin to the specified objects Created in NX6.0.0. More... | |
| void | SetInferRelativeToGeometry (bool inferRelativeToGeometry) |
| Infers a relative to geometry associative on commit if no other associativity has been applied Created in NX6.0.1. More... | |
| void | SetOriginPoint (const NXOpen::Point3d &origin) |
| Sets the origin point Created in NX6.0.0. 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... | |
Detailed Description
Represents a NXOpen::Annotations::OriginBuilder
This is a sub-builder class and cannot be directly instantiated
Created in NX6.0.0.
Member Enumeration Documentation
alignment position on the annotation
Member Function Documentation
| NXOpen::Annotations::OriginBuilder::AlignmentPosition NXOpen::Annotations::OriginBuilder::Anchor | ( | ) |
Returns the anchor location of the origin on the annotation
Created in NX6.0.0.
License requirements : None
| NXOpen::Drawings::SelectDraftingView* NXOpen::Annotations::OriginBuilder::AnnotationView | ( | ) |
Returns the view of the annotation (drafting member views only)
Created in NX6.0.0.
License requirements : None
| NXOpen::Annotations::Annotation::AssociativeOriginData NXOpen::Annotations::OriginBuilder::GetAssociativeOrigin | ( | ) |
Gets the data that specifies the origin's associativity.
- Returns
- associativity data
Created in NX6.0.0.
License requirements : None
| NXOpen::SelectDisplayableObject* NXOpen::Annotations::OriginBuilder::Origin | ( | ) |
Returns the origin
Created in NX6.0.0.
License requirements : None
| NXOpen::Point3d NXOpen::Annotations::OriginBuilder::OriginPoint | ( | ) |
Returns the origin point
Created in NX6.0.0.
License requirements : None
| NXOpen::Annotations::PlaneBuilder* NXOpen::Annotations::OriginBuilder::Plane | ( | ) |
Returns the plane
Created in NX6.0.0.
License requirements : None
| void NXOpen::Annotations::OriginBuilder::SetAnchor | ( | NXOpen::Annotations::OriginBuilder::AlignmentPosition | anchor | ) |
Sets the anchor location of the origin on the annotation
Created in NX6.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")
- Parameters
-
anchor anchor
| void NXOpen::Annotations::OriginBuilder::SetAssociativeOrigin | ( | const NXOpen::Annotations::Annotation::AssociativeOriginData & | assocOrigin | ) |
Associates the annotation's origin to the specified objects
Created in NX6.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")
- Parameters
-
assocOrigin associativity data
| void NXOpen::Annotations::OriginBuilder::SetInferRelativeToGeometry | ( | bool | inferRelativeToGeometry | ) |
Infers a relative to geometry associative on commit if no other associativity has been applied
Created in NX6.0.1.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")
- Parameters
-
inferRelativeToGeometry relative to geometry flag
| void NXOpen::Annotations::OriginBuilder::SetOriginPoint | ( | const NXOpen::Point3d & | origin | ) |
Sets the origin point
Created in NX6.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")
- Parameters
-
origin origin
|
virtual |
Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.
- Returns
- Was self validation successful
Created in NX3.0.1.
License requirements : None
Implements NXOpen::GeometricUtilities::IComponentBuilder.
The documentation for this class was generated from the following file:
- Annotations_OriginBuilder.hxx