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

Represents a NXOpen::Annotations::LocatorDesignator builder
To create a new instance of this class, use NXOpen::Annotations::PmiAttributeCollection::CreateLocatorDesignatorBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::LocatorDesignatorBuilder:
NXOpen::Annotations::PmiAttributeBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString CoordinatePlane ()
 Returns the coordinateplane
Created in NX6.0.0. More...
 
NXOpen::PointHotSpot ()
 Returns the hot spot
Created in NX6.0.0. More...
 
NXString HotSpotText ()
 Returns the hot spot text
Created in NX6.0.0. More...
 
NXString LocatorLetter ()
 Returns the locatorletter
Created in NX6.0.0. More...
 
NXString LocatorType ()
 Returns the locatortype
Created in NX6.0.0. More...
 
NXOpen::DirectionNormalDirection ()
 Returns the normal direction
Created in NX6.0.0. More...
 
NXString NoteText ()
 Returns the notetext
Created in NX6.0.0. More...
 
NXOpen::DirectionPinDirection ()
 Returns the pin direction
Created in NX6.0.0. More...
 
NXOpen::DirectionPunchDirection ()
 Returns the punch direction
Created in NX6.0.0. More...
 
void SetCoordinatePlane (const NXString &coordinatePlane)
 Sets the coordinateplane
Created in NX6.0.0. More...
 
void SetCoordinatePlane (const char *coordinatePlane)
 Sets the coordinateplane
Created in NX6.0.0. More...
 
void SetHotSpot (NXOpen::Point *hotSpot)
 Sets the hot spot
Created in NX6.0.0. More...
 
void SetHotSpotText (const NXString &hotSpotText)
 Sets the hot spot text
Created in NX6.0.0. More...
 
void SetHotSpotText (const char *hotSpotText)
 Sets the hot spot text
Created in NX6.0.0. More...
 
void SetLocatorLetter (const NXString &locatorLetter)
 Sets the locatorletter
Created in NX6.0.0. More...
 
void SetLocatorLetter (const char *locatorLetter)
 Sets the locatorletter
Created in NX6.0.0. More...
 
void SetLocatorType (const NXString &locatorType)
 Sets the locatortype
Created in NX6.0.0. More...
 
void SetLocatorType (const char *locatorType)
 Sets the locatortype
Created in NX6.0.0. More...
 
void SetNormalDirection (NXOpen::Direction *normalDirection)
 Sets the normal direction
Created in NX6.0.0. More...
 
void SetNoteText (const NXString &noteText)
 Sets the notetext
Created in NX6.0.0. More...
 
void SetNoteText (const char *noteText)
 Sets the notetext
Created in NX6.0.0. More...
 
void SetPinDirection (NXOpen::Direction *pinDirection)
 Sets the pin direction
Created in NX6.0.0. More...
 
void SetPunchDirection (NXOpen::Direction *punchDirection)
 Sets the punch direction
Created in NX6.0.0. More...
 
void SetSubscript (const NXString &subscript)
 Sets the subscript
Created in NX6.0.0. More...
 
void SetSubscript (const char *subscript)
 Sets the subscript
Created in NX6.0.0. More...
 
void SetTitle (const NXString &title)
 Sets the str title
Created in NX6.0.0. More...
 
void SetTitle (const char *title)
 Sets the str title
Created in NX6.0.0. More...
 
NXString Subscript ()
 Returns the subscript
Created in NX6.0.0. More...
 
NXString Title ()
 Returns the str title
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Annotations::PmiAttributeBuilder
NXOpen::Annotations::AssociatedObjectsBuilderAssociatedObjects ()
 Returns the NXOpen::Annotations::AssociatedObjectsBuilder for the annotation
Created in NX6.0.0. More...
 
NXOpen::Annotations::PmiAttribute ()
 Returns the NXOpen::Annotations::Pmi for this annotation
Created in NX6.0.0. More...
 
NXOpen::NXObjectBusinessModifier ()
 Returns the business modifier
Created in NX6.0.0. More...
 
std::vector< NXOpen::NXObject * > GetAttributeValues ()
 Returns the attribute values. More...
 
NXString KnowledgeFusionClassName ()
 Returns the knowledge fusion class name file, the default class is UG provided pmi KF class
Created in NX6.0.0. More...
 
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the NXOpen::Annotations::OriginBuilder for the annotation
Created in NX6.0.0. More...
 
void SetAttribute (NXOpen::Annotations::Pmi *attribute)
 Sets the NXOpen::Annotations::Pmi for this annotation
Created in NX6.0.0. More...
 
void SetAttributeValues (const std::vector< NXOpen::NXObject * > &attributeValues)
 Sets the attribute values
Created in NX6.0.0. More...
 
void SetBusinessModifier (NXOpen::NXObject *businessModifier)
 Sets the business modifier
Created in NX6.0.0. More...
 
void SetKnowledgeFusionClassName (const NXString &knowledgeFusionClassName)
 Sets the knowledge fusion class name file, the default class is UG provided pmi KF class
Created in NX6.0.0. More...
 
void SetKnowledgeFusionClassName (const char *knowledgeFusionClassName)
 Sets the knowledge fusion class name file, the default class is UG provided pmi KF class
Created in NX6.0.0. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the NXOpen::Annotations::StyleBuilder for the annotation
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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...
 

Detailed Description

Represents a NXOpen::Annotations::LocatorDesignator builder
To create a new instance of this class, use NXOpen::Annotations::PmiAttributeCollection::CreateLocatorDesignatorBuilder

Created in NX6.0.0.


Member Function Documentation

NXString NXOpen::Annotations::LocatorDesignatorBuilder::CoordinatePlane ( )

Returns the coordinateplane
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Annotations::LocatorDesignatorBuilder::HotSpot ( )

Returns the hot spot
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::LocatorDesignatorBuilder::HotSpotText ( )

Returns the hot spot text
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::LocatorDesignatorBuilder::LocatorLetter ( )

Returns the locatorletter
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::LocatorDesignatorBuilder::LocatorType ( )

Returns the locatortype
Created in NX6.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Annotations::LocatorDesignatorBuilder::NormalDirection ( )

Returns the normal direction
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::LocatorDesignatorBuilder::NoteText ( )

Returns the notetext
Created in NX6.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Annotations::LocatorDesignatorBuilder::PinDirection ( )

Returns the pin direction
Created in NX6.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Annotations::LocatorDesignatorBuilder::PunchDirection ( )

Returns the punch direction
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::LocatorDesignatorBuilder::SetCoordinatePlane ( const NXString coordinatePlane)

Sets the coordinateplane
Created in NX6.0.0.



License requirements : None

Parameters
coordinatePlanecoordinateplane
void NXOpen::Annotations::LocatorDesignatorBuilder::SetCoordinatePlane ( const char *  coordinatePlane)

Sets the coordinateplane
Created in NX6.0.0.



License requirements : None

Parameters
coordinatePlanecoordinateplane
void NXOpen::Annotations::LocatorDesignatorBuilder::SetHotSpot ( NXOpen::Point hotSpot)

Sets the hot spot
Created in NX6.0.0.



License requirements : None

Parameters
hotSpothotspot
void NXOpen::Annotations::LocatorDesignatorBuilder::SetHotSpotText ( const NXString hotSpotText)

Sets the hot spot text
Created in NX6.0.0.



License requirements : None

Parameters
hotSpotTexthotspottext
void NXOpen::Annotations::LocatorDesignatorBuilder::SetHotSpotText ( const char *  hotSpotText)

Sets the hot spot text
Created in NX6.0.0.



License requirements : None

Parameters
hotSpotTexthotspottext
void NXOpen::Annotations::LocatorDesignatorBuilder::SetLocatorLetter ( const NXString locatorLetter)

Sets the locatorletter
Created in NX6.0.0.



License requirements : None

Parameters
locatorLetterlocatorletter
void NXOpen::Annotations::LocatorDesignatorBuilder::SetLocatorLetter ( const char *  locatorLetter)

Sets the locatorletter
Created in NX6.0.0.



License requirements : None

Parameters
locatorLetterlocatorletter
void NXOpen::Annotations::LocatorDesignatorBuilder::SetLocatorType ( const NXString locatorType)

Sets the locatortype
Created in NX6.0.0.



License requirements : None

Parameters
locatorTypelocatortype
void NXOpen::Annotations::LocatorDesignatorBuilder::SetLocatorType ( const char *  locatorType)

Sets the locatortype
Created in NX6.0.0.



License requirements : None

Parameters
locatorTypelocatortype
void NXOpen::Annotations::LocatorDesignatorBuilder::SetNormalDirection ( NXOpen::Direction normalDirection)

Sets the normal direction
Created in NX6.0.0.



License requirements : None

Parameters
normalDirectionnormaldirection
void NXOpen::Annotations::LocatorDesignatorBuilder::SetNoteText ( const NXString noteText)

Sets the notetext
Created in NX6.0.0.



License requirements : None

Parameters
noteTextnotetext
void NXOpen::Annotations::LocatorDesignatorBuilder::SetNoteText ( const char *  noteText)

Sets the notetext
Created in NX6.0.0.



License requirements : None

Parameters
noteTextnotetext
void NXOpen::Annotations::LocatorDesignatorBuilder::SetPinDirection ( NXOpen::Direction pinDirection)

Sets the pin direction
Created in NX6.0.0.



License requirements : None

Parameters
pinDirectionpindirection
void NXOpen::Annotations::LocatorDesignatorBuilder::SetPunchDirection ( NXOpen::Direction punchDirection)

Sets the punch direction
Created in NX6.0.0.



License requirements : None

Parameters
punchDirectionpunchdirection
void NXOpen::Annotations::LocatorDesignatorBuilder::SetSubscript ( const NXString subscript)

Sets the subscript
Created in NX6.0.0.



License requirements : None

Parameters
subscriptsubscript
void NXOpen::Annotations::LocatorDesignatorBuilder::SetSubscript ( const char *  subscript)

Sets the subscript
Created in NX6.0.0.



License requirements : None

Parameters
subscriptsubscript
void NXOpen::Annotations::LocatorDesignatorBuilder::SetTitle ( const NXString title)

Sets the str title
Created in NX6.0.0.



License requirements : None

Parameters
titletitle
void NXOpen::Annotations::LocatorDesignatorBuilder::SetTitle ( const char *  title)

Sets the str title
Created in NX6.0.0.



License requirements : None

Parameters
titletitle
NXString NXOpen::Annotations::LocatorDesignatorBuilder::Subscript ( )

Returns the subscript
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::LocatorDesignatorBuilder::Title ( )

Returns the str title
Created in NX6.0.0.



License requirements : None


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