NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::LineTarget Class Reference

Represents a line datum target
To create or edit an instance of this class, use Annotations::PmiDatumTargetBuilder

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::LineTarget:
NXOpen::Annotations::DatumTarget NXOpen::Annotations::ILineTarget NXOpen::Annotations::DraftingDatumTarget NXOpen::Annotations::IPmi NXOpen::INXObject NXOpen::Annotations::BaseDatumTarget NXOpen::INXObject NXOpen::Annotations::Gdt NXOpen::Annotations::IDatumTarget NXOpen::Annotations::SimpleDraftingAid NXOpen::Annotations::IFcf NXOpen::INXObject NXOpen::Annotations::DraftingAid NXOpen::INXObject NXOpen::Annotations::Annotation NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Public Member Functions

virtual NXOpen::Point3d EndPointCoordinates ()
 Returns the target end point coordinates
Created in NX4.0.0.
 
virtual NXOpen::Point3d StartPointCoordinates ()
 Returns the target start point coordinates
Created in NX4.0.0.
 
- Public Member Functions inherited from NXOpen::Annotations::DatumTarget
virtual
NXOpen::Annotations::AssociatedObject
GetAssociatedObject ()
 Returns the associated object.
 
virtual std::vector
< NXOpen::Annotations::BusinessModifier * > 
GetBusinessModifiers ()
 Returns the business modifiers.
 
virtual
NXOpen::Annotations::AssociatedObject
GetSharedAssociatedObject ()
 Returns the shared associated objects.
 
virtual int Index ()
 Returns the index.
 
virtual bool IsMirrored ()
 Returns a flag indicating whether the annotation is mirrored
Created in NX8.5.0.
 
virtual void SetAssociatedObject (NXOpen::Annotations::AssociatedObject *assocObj)
 Sets the associated object.
 
virtual void SetBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers)
 Sets the business modifiers.
 
virtual void SetIndex (int index)
 Sets the index.
 
- Public Member Functions inherited from NXOpen::Annotations::DraftingDatumTarget
NXOpen::Annotations::ArbitraryTargetConvertToAreaTarget ()
 Converts a datum target point, line, or non-rectangular area to a rectangular area.
 
NXOpen::Annotations::DraftingArbitraryTargetConvertToDraftingAreaTarget ()
 Converts a drafting datum target point, line, or non-rectangular area to a drafting rectangular area.
 
NXOpen::Annotations::DraftingLineTargetConvertToDraftingLineTarget ()
 Converts a drafting datum target point or area to a drafting datum target line.
 
NXOpen::Annotations::DraftingPointTargetConvertToDraftingPointTarget ()
 Converts a drafting datum target line or area to a drafting datum target point.
 
NXOpen::Annotations::LineTargetConvertToLineTarget ()
 Converts a datum target point or area to a datum target line.
 
NXOpen::Annotations::PointTargetConvertToPointTarget ()
 Converts a datum target line or area to a datum target point.
 
- Public Member Functions inherited from NXOpen::Annotations::BaseDatumTarget
virtual NXString DatumLabel ()
 Returns the datum target label.
 
virtual void SetDatumLabel (const NXString &datumLabel)
 Sets the datum target label.
 
void SetDatumLabel (const char *datumLabel)
 Sets the datum target label.
 
virtual void SetTargetIndex (int index)
 Sets the datum target index.
 
virtual int TargetIndex ()
 Returns the datum target index.
 
- Public Member Functions inherited from NXOpen::Annotations::Gdt
bool CanChangeLeaderPositionParameter ()
 Returns a flag indicating whether the Annotations::Gdt::LeaderPositionParameter can be changed
Created in NX3.0.0.
 
virtual
NXOpen::Annotations::FcfFrameData
GetFcfFrameData ()
 Returns the single FCF frames data.
 
virtual std::vector
< NXOpen::Annotations::FcfFrameData * > 
GetFcfFrameDataArray ()
 Returns the multiple FCF frames data.
 
bool HasLeaderPositionParameter ()
 Returns a flag indicating whether this GDT has a leader position parameter.
 
bool HasStubbedDatumStyle ()
 Returns a flag indicating whether the leader has a stubbed datum style.
 
double LeaderPositionParameter ()
 Returns a parameter which indicates where the leader end point is located on the object that it is attached to.
 
virtual void SetFcfFrameData (NXOpen::Annotations::FcfFrameData *data)
 Sets the single FCF frames data.
 
virtual void SetFcfFrameData (const std::vector< NXOpen::Annotations::FcfFrameData * > &fcfFrameData)
 Sets the multiple FCF frames data.
 
void SetHasStubbedDatumStyle (bool stubbed)
 Sets a flag indicating whether the leader has a stubbed datum style.
 
void SetLeaderPositionParameter (double param)
 Sets a parameter which indicates where the leader end point is located on the object that it is attached to.
 
void SetSymbolCfw (const NXOpen::Annotations::LineCfw &cfw)
 Sets the symbol color, font, and width.
 
- Public Member Functions inherited from NXOpen::Annotations::SimpleDraftingAid
std::vector< NXStringGetText ()
 Returns the drafting aid's text.
 
NXOpen::Annotations::UserSymbolPreferencesGetUserSymbolPreferences ()
 Returns the user symbol preferences.
 
void GetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType *sizeType, double *lengthOrScale, double *heightOrAspectRatio)
 Gets the user symbol size
Created in NX3.0.0.
 
void SetText (std::vector< NXString > &lines)
 Sets the drafting aid's text.
 
void SetUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences *usymPrefs)
 Sets the user symbol preferences.
 
void SetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
 Sets the user symbol size.
 
- Public Member Functions inherited from NXOpen::Annotations::IDatumTarget
void SetDatumLabel (const char *datumLabel)
 Sets the datum target label.
 
- Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
void SetName (const char *name)
 Sets the custom name of the object.
 

Additional Inherited Members

- Public Types inherited from NXOpen::DisplayableObject
enum  ObjectFont {
  ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline,
  ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed
}
 specifies the object font for objects such as lines
Created in NX3.0.0. More...
 
enum  ObjectWidth {
  ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5,
  ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive,
  ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine
}
 specifies object width for objects such as lines and text
Created in NX3.0.0. More...
 

Detailed Description

Represents a line datum target
To create or edit an instance of this class, use Annotations::PmiDatumTargetBuilder

Created in NX4.0.0.


Member Function Documentation

virtual NXOpen::Point3d NXOpen::Annotations::LineTarget::EndPointCoordinates ( )
virtual

Returns the target end point coordinates
Created in NX4.0.0.



License requirements : None

Implements NXOpen::Annotations::ILineTarget.

virtual NXOpen::Point3d NXOpen::Annotations::LineTarget::StartPointCoordinates ( )
virtual

Returns the target start point coordinates
Created in NX4.0.0.



License requirements : None

Implements NXOpen::Annotations::ILineTarget.


The documentation for this class was generated from the following file:
Copyright 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.