NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::OriginBuilder Class Reference

Represents a Annotations::OriginBuilder
This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::OriginBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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.
NXOpen::Drawings::SelectDraftingViewAnnotationView ()
 Returns the view of the annotation (drafting member views only)
Created in NX6.0.0.
NXOpen::Annotations::Annotation::AssociativeOriginData GetAssociativeOrigin ()
 Gets the data that specifies the origin's associativity.
NXOpen::SelectDisplayableObjectOrigin ()
 Returns the origin
Created in NX6.0.0.
NXOpen::Point3d OriginPoint ()
 Returns the origin point
Created in NX6.0.0.
NXOpen::Annotations::PlaneBuilderPlane ()
 Returns the plane
Created in NX6.0.0.
void SetAnchor (NXOpen::Annotations::OriginBuilder::AlignmentPosition anchor)
 Sets the anchor location of the origin on the annotation
Created in NX6.0.0.
void SetAssociativeOrigin (const NXOpen::Annotations::Annotation::AssociativeOriginData &assocOrigin)
 Associates the annotation's origin to the specified objects
Created in NX6.0.0.
void SetInferRelativeToGeometry (bool inferRelativeToGeometry)
 Infers a relative to geometry associative on commit if no other associativity has been applied
Created in NX6.0.1.
void SetOriginPoint (const NXOpen::Point3d &origin)
 Sets the origin point
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a 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

Enumerator:
AlignmentPositionTopLeft 

Top left position.

AlignmentPositionTopCenter 

Top center position.

AlignmentPositionTopRight 

Top right position.

AlignmentPositionMidLeft 

Mid left position.

AlignmentPositionMidCenter 

Mid center position.

AlignmentPositionMidRight 

Mid right position.

AlignmentPositionBottomLeft 

Bottom left position.

AlignmentPositionBottomCenter 

Bottom center position.

AlignmentPositionBottomRight 

Bottom right position.


Member Function Documentation

Returns the anchor location of the origin on the annotation
Created in NX6.0.0.



License requirements : None

Returns the view of the annotation (drafting member views only)
Created in NX6.0.0.



License requirements : None

Gets the data that specifies the origin's associativity.

Returns:
associativity data
Created in NX6.0.0.

License requirements : None

Returns the origin
Created in NX6.0.0.



License requirements : None

Returns the origin point
Created in NX6.0.0.



License requirements : None

Returns the plane
Created in NX6.0.0.



License requirements : None

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:
anchoranchor

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:
assocOriginassociativity data

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:
inferRelativeToGeometryrelative to geometry flag

Sets the origin point
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")

Parameters:
originorigin

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.