Represents the data for all the leaders of an annotation
Created in NX3.0.0. More...

Inheritance diagram for NXOpen::Annotations::LeaderBundle:

Public Member Functions
NXOpen::Annotations::LeaderAlignment	LeaderAlignment ()
	Returns the leader alignment Created in NX3.0.0.

NXOpen::Annotations::LeaderSide	LeaderSide ()
	Returns the leader side Created in NX3.0.0.

NXOpen::Annotations::LeaderType	LeaderType ()
	Returns the leader type Created in NX3.0.0.

int	NumberOfLeaders ()
	Returns the number of leaders.

void	SetLeaderAlignment (NXOpen::Annotations::LeaderAlignment leaderAlignment)
	Sets the leader alignment Created in NX3.0.0.

void	SetLeaderData (int n, NXOpen::Annotations::LeaderAttachment attachmentType, NXOpen::NXObject attachmentObject, NXOpen::View attachmentView, const NXOpen::Point3d &endPoint, double angle, const std::vector< NXOpen::Point3d > &intermediatePoints)
	Sets the leader data for the nth leader Created in NX3.0.0.

void	SetLeaderSide (NXOpen::Annotations::LeaderSide leaderSide)
	Sets the leader side Created in NX3.0.0.

void	SetLeaderType (NXOpen::Annotations::LeaderType leaderType)
	Sets the leader type Created in NX3.0.0.

void	SetNumberOfLeaders (int numLeaders)
	Sets the number of leaders.

virtual	~LeaderBundle ()
	Frees the object from memory.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

Represents the data for all the leaders of an annotation
Created in NX3.0.0.

Constructor & Destructor Documentation

virtual NXOpen::Annotations::LeaderBundle::~LeaderBundle ( )

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX3.0.0.

License requirements : None

Member Function Documentation

NXOpen::Annotations::LeaderAlignment NXOpen::Annotations::LeaderBundle::LeaderAlignment ( )

Returns the leader alignment
Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::LeaderSide NXOpen::Annotations::LeaderBundle::LeaderSide ( )

Returns the leader side
Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::LeaderType NXOpen::Annotations::LeaderBundle::LeaderType ( )

Returns the leader type
Created in NX3.0.0.

License requirements : None

int NXOpen::Annotations::LeaderBundle::NumberOfLeaders ( )

Returns the number of leaders.

   Must not exceed
   @link Annotations::ConstantsMaxLeaders Annotations::ConstantsMaxLeaders@endlink .
   The only leader types that permit more than one leader are the following:
   Plain, Around, PlainAligned, and AroundAligned.
   PlainAligned and AroundAligned require at least one leader.

Created in NX3.0.0.

License requirements : None

void NXOpen::Annotations::LeaderBundle::SetLeaderAlignment ( NXOpen::Annotations::LeaderAlignment leaderAlignment )

Sets the leader alignment
Created in NX3.0.0.

License requirements : None

Parameters

leaderAlignment leader alignment

void NXOpen::Annotations::LeaderBundle::SetLeaderData	(	int	n,
		NXOpen::Annotations::LeaderAttachment	attachmentType,
		NXOpen::NXObject *	attachmentObject,
		NXOpen::View *	attachmentView,
		const NXOpen::Point3d &	endPoint,
		double	angle,
		const std::vector< NXOpen::Point3d > &	intermediatePoints
	)

Sets the leader data for the nth leader
Created in NX3.0.0.

License requirements : None

Parameters

n	The leader to set the data for
attachmentType	attachment type
attachmentObject	Attachment object. Should be NULL if the attachment type is Screen. Must not be NULL if the attachment type is OnObject.
attachmentView	The view that the leader will be associated with. Must not be NULL
endPoint	The coordinates of the leader's end point. If the attachment type is Screen, the coordinates will be view coordinates. If the attachment type is OnObject, the coordinates will be in the absolute coordinate system of the model that owns the attachment object
angle	angle
intermediatePoints	Intermediate points for the leader. The number of points must not exceed Annotations::ConstantsMaxLeaderIntermediatePoints . The points are in the view coordinate system. The only leader types that permit intermediate points are the following: Plain, Around, PlainAligned, AroundAligned, DatumArrow, and GbDatumArrow.

void NXOpen::Annotations::LeaderBundle::SetLeaderSide ( NXOpen::Annotations::LeaderSide leaderSide )

Sets the leader side
Created in NX3.0.0.

License requirements : None

Parameters

leaderSide leader side

void NXOpen::Annotations::LeaderBundle::SetLeaderType ( NXOpen::Annotations::LeaderType leaderType )

Sets the leader type
Created in NX3.0.0.

License requirements : None

Parameters

leaderType leader type

void NXOpen::Annotations::LeaderBundle::SetNumberOfLeaders ( int numLeaders )

Sets the number of leaders.

   Must not exceed
   @link Annotations::ConstantsMaxLeaders Annotations::ConstantsMaxLeaders@endlink .
   The only leader types that permit more than one leader are the following:
   Plain, Around, PlainAligned, and AroundAligned.
   PlainAligned and AroundAligned require at least one leader.

Created in NX3.0.0.

License requirements : None

Parameters

numLeaders num leaders

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

Annotations_LeaderBundle.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation