NXOpen::Annotations::LeaderData Class Reference

Represents a NXOpen::Annotations::LeaderData . More...

Inheritance diagram for NXOpen::Annotations::LeaderData:

Public Types
enum	ArrowheadType {   ArrowheadTypeClosedArrow, ArrowheadTypeClosedSolidArrow, ArrowheadTypeOpenArrow, ArrowheadTypeFilledArrow,   ArrowheadTypeClosedDoubleArrow, ArrowheadTypeClosedDoubleSolidArrow, ArrowheadTypeOpenDoubleArrow, ArrowheadTypeFilledDoubleArrow,   ArrowheadTypeNone, ArrowheadTypeOrigin, ArrowheadTypeCross, ArrowheadTypeIntegral,   ArrowheadTypeDot, ArrowheadTypeFilledDot, ArrowheadTypeSquare, ArrowheadTypeFilledSquare,   ArrowheadTypeDatum, ArrowheadTypeFilledDatum, ArrowheadTypeTopOpenArrow, ArrowheadTypeBottomOpenArrow,   ArrowheadTypeTopFilledArrow, ArrowheadTypeBottomFilledArrow }
	the set of arrowhead types used to define a leader arrowhead More...
enum	LeaderType {   LeaderTypePlain, LeaderTypeAllAround, LeaderTypePlainWithoutStub, LeaderTypeFlag,   LeaderTypeDatum, LeaderTypeDotTerminated, LeaderTypeExtension, LeaderTypeAllOver }
	the set of datatypes used to define the types of leaders that can be applied to an annotation More...

Public Member Functions
NXOpen::Annotations::LeaderData::ArrowheadType	Arrowhead ()
	Returns the arrowhead Created in NX6.0.0. More...
NXOpen::Annotations::LeaderData::ArrowheadType	DatumOnDotTerminatedArrowhead ()
	Returns the datum arrowhead type for the datum portion of a datum on dot terminated leader Created in NX9.0.0. More...
NXOpen::Point3d	DatumOnDotTerminatedEndPoint ()
	Returns the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet Created in NX9.0.0. More...
NXOpen::Point3d	DatumOnDotTerminatedStartPoint ()
	Returns the datum start point for the leader segment of the datum portion of a datum on dot terminated leader Created in NX9.0.0. More...
NXOpen::SelectDisplayableObjectList *	Jogs ()
	Returns the jogs Created in NX6.0.0. More...
NXOpen::SelectDisplayableObject *	Leader ()
	Returns the leader Created in NX6.0.0. More...
bool	LeaderPerpendicular ()
	Returns the perpendicular relationship between the first segment and attachement object Created in NX10.0.0. More...
bool	Perpendicular ()
	Returns the perpendicular relationship between the first segment and stub Created in NX7.0.0. More...
void	SetArrowhead (NXOpen::Annotations::LeaderData::ArrowheadType arrowhead)
	Sets the arrowhead Created in NX6.0.0. More...
void	SetDatumOnDotTerminatedArrowhead (NXOpen::Annotations::LeaderData::ArrowheadType arrowhead)
	Sets the datum arrowhead type for the datum portion of a datum on dot terminated leader Created in NX9.0.0. More...
void	SetDatumOnDotTerminatedEndPoint (const NXOpen::Point3d &endpoint)
	Sets the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet Created in NX9.0.0. More...
void	SetDatumOnDotTerminatedStartPoint (const NXOpen::Point3d &startpoint)
	Sets the datum start point for the leader segment of the datum portion of a datum on dot terminated leader Created in NX9.0.0. More...
void	SetLeaderPerpendicular (bool isLeaderPerpendicular)
	Sets the perpendicular relationship between the first segment and attachement object Created in NX10.0.0. More...
void	SetPerpendicular (bool isPerpendicular)
	Sets the perpendicular relationship between the first segment and stub Created in NX7.0.0. More...
void	SetStubSide (NXOpen::Annotations::LeaderSide stubSide)
	Sets the stub side Created in NX6.0.0. More...
void	SetStubSize (double stubSize)
	Sets the stub size Created in NX6.0.0. More...
void	SetTerminatorType (NXOpen::Annotations::LeaderData::LeaderType terminatorType)
	Sets the terminator type Created in NX6.0.0. More...
void	SetVerticalAttachment (NXOpen::Annotations::LeaderVerticalAttachment verticalAttachment)
	Sets the vertical attachment Created in NX10.0.0. More...
NXOpen::Annotations::LeaderSide	StubSide ()
	Returns the stub side Created in NX6.0.0. More...
double	StubSize ()
	Returns the stub size Created in NX6.0.0. More...
NXOpen::Annotations::LeaderData::LeaderType	TerminatorType ()
	Returns the terminator type Created in NX6.0.0. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
NXOpen::Annotations::LeaderVerticalAttachment	VerticalAttachment ()
	Returns the vertical attachment Created in NX10.0.0. 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::LeaderData .

This class is used to construct the definition for a single leader object.
To create a new instance of this class, use NXOpen::Annotations::AnnotationManager::CreateLeaderData

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::LeaderData::ArrowheadType

the set of arrowhead types used to define a leader arrowhead

Enumerator
ArrowheadTypeClosedArrow	Closed arrowhead type.
ArrowheadTypeClosedSolidArrow	Closed solid arrowhead type.
ArrowheadTypeOpenArrow	Open arrowhead type.
ArrowheadTypeFilledArrow	Filled arrowhead type.
ArrowheadTypeClosedDoubleArrow	Closed double arrowhead type.
ArrowheadTypeClosedDoubleSolidArrow	Closed double solid arrowhead type.
ArrowheadTypeOpenDoubleArrow	Open double arrowhead type.
ArrowheadTypeFilledDoubleArrow	Filled double arrowhead type.
ArrowheadTypeNone	No terminating symbol.
ArrowheadTypeOrigin	Origin symbol.
ArrowheadTypeCross	Cross symbol.
ArrowheadTypeIntegral	Integral symbol.
ArrowheadTypeDot	Dot symbol.
ArrowheadTypeFilledDot	Filled dot symbol.
ArrowheadTypeSquare	Square symbol.
ArrowheadTypeFilledSquare	Filled square symbol.
ArrowheadTypeDatum	Datum symbol.
ArrowheadTypeFilledDatum	Filled datum symbol.
ArrowheadTypeTopOpenArrow	Top open arrowhead.
ArrowheadTypeBottomOpenArrow	bottom open arrowhead
ArrowheadTypeTopFilledArrow	top filled arrowhead
ArrowheadTypeBottomFilledArrow	bottom filled arrowhead

enum NXOpen::Annotations::LeaderData::LeaderType

the set of datatypes used to define the types of leaders that can be applied to an annotation

Enumerator
LeaderTypePlain	Plain leader style.
LeaderTypeAllAround	Plain leader style with all around symbol.
LeaderTypePlainWithoutStub	Plain leader style with no stub.
LeaderTypeFlag	Flag style.
LeaderTypeDatum	Datum feature symbol style.
LeaderTypeDotTerminated	Datum feature on stub of dot terminated style.
LeaderTypeExtension	Id symbol extension style leader.
LeaderTypeAllOver	all over

Member Function Documentation

NXOpen::Annotations::LeaderData::ArrowheadType NXOpen::Annotations::LeaderData::Arrowhead

(

)

Returns the arrowhead
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::LeaderData::ArrowheadType NXOpen::Annotations::LeaderData::DatumOnDotTerminatedArrowhead

(

)

Returns the datum arrowhead type for the datum portion of a datum on dot terminated leader
Created in NX9.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Annotations::LeaderData::DatumOnDotTerminatedEndPoint

(

)

Returns the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet
Created in NX9.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Annotations::LeaderData::DatumOnDotTerminatedStartPoint

(

)

Returns the datum start point for the leader segment of the datum portion of a datum on dot terminated leader
Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Annotations::LeaderData::Jogs

(

)

Returns the jogs
Created in NX6.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::LeaderData::Leader

(

)

Returns the leader
Created in NX6.0.0.

License requirements : None

bool NXOpen::Annotations::LeaderData::LeaderPerpendicular

(

)

Returns the perpendicular relationship between the first segment and attachement object
Created in NX10.0.0.

License requirements : None

bool NXOpen::Annotations::LeaderData::Perpendicular

(

)

Returns the perpendicular relationship between the first segment and stub
Created in NX7.0.0.

License requirements : None

void NXOpen::Annotations::LeaderData::SetArrowhead

(

NXOpen::Annotations::LeaderData::ArrowheadType

arrowhead

)

Sets the arrowhead
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

arrowhead

arrowhead

void NXOpen::Annotations::LeaderData::SetDatumOnDotTerminatedArrowhead

(

NXOpen::Annotations::LeaderData::ArrowheadType

arrowhead

)

Sets the datum arrowhead type for the datum portion of a datum on dot terminated leader
Created in NX9.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

arrowhead

arrowhead

void NXOpen::Annotations::LeaderData::SetDatumOnDotTerminatedEndPoint

(

const NXOpen::Point3d &

endpoint

)

Sets the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet
Created in NX9.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

endpoint

endpoint

void NXOpen::Annotations::LeaderData::SetDatumOnDotTerminatedStartPoint

(

const NXOpen::Point3d &

startpoint

)

Sets the datum start point for the leader segment of the datum portion of a datum on dot terminated leader
Created in NX9.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

startpoint

startpoint

void NXOpen::Annotations::LeaderData::SetLeaderPerpendicular

(

bool

isLeaderPerpendicular

)

Sets the perpendicular relationship between the first segment and attachement object
Created in NX10.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

isLeaderPerpendicular

isleaderperpendicular

void NXOpen::Annotations::LeaderData::SetPerpendicular

(

bool

isPerpendicular

)

Sets the perpendicular relationship between the first segment and stub
Created in NX7.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

isPerpendicular

isperpendicular

void NXOpen::Annotations::LeaderData::SetStubSide

(

NXOpen::Annotations::LeaderSide

stubSide

)

Sets the stub side
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

stubSide

stub side

void NXOpen::Annotations::LeaderData::SetStubSize

(

double

stubSize

)

Sets the stub size
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

stubSize

stubsize

void NXOpen::Annotations::LeaderData::SetTerminatorType

(

NXOpen::Annotations::LeaderData::LeaderType

terminatorType

)

Sets the terminator type
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

terminatorType

terminatortype

void NXOpen::Annotations::LeaderData::SetVerticalAttachment

(

NXOpen::Annotations::LeaderVerticalAttachment

verticalAttachment

)

Sets the vertical attachment
Created in NX10.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

verticalAttachment

vertical attachment

NXOpen::Annotations::LeaderSide NXOpen::Annotations::LeaderData::StubSide

(

)

Returns the stub side
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::LeaderData::StubSize

(

)

Returns the stub size
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::LeaderData::LeaderType NXOpen::Annotations::LeaderData::TerminatorType

(

)

Returns the terminator type
Created in NX6.0.0.

License requirements : None

virtual bool NXOpen::Annotations::LeaderData::Validate ( )

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.

NXOpen::Annotations::LeaderVerticalAttachment NXOpen::Annotations::LeaderData::VerticalAttachment

(

)

Returns the vertical attachment
Created in NX10.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• Annotations_LeaderData.hxx