NXOpen::Formboard::PathLengthAnnotationBuilder Class Reference

TODO Class documentation
To create a new instance of this class, use NXOpen::Formboard::FormboardManager::CreatePathLengthAnnotationBuilder
Default values. More...

Inheritance diagram for NXOpen::Formboard::PathLengthAnnotationBuilder:

Public Types
enum	Types { TypesPointsOnCurves, TypesRoutingPathLength }
	TODO: Document the whole type. More...

Public Member Functions
void	CreatePointsAtRcps (NXOpen::Routing::ControlPoint *firstEndRcp, NXOpen::Routing::ControlPoint *secondEndRcp)
	Create builder end points at the RCP locations Created in NX7.5.0. More...
NXString	ExpressionName ()
	Returns the expression name Created in NX7.5.0. More...
NXOpen::Point *	FirstEndPoint ()
	Returns the first end point Created in NX7.5.0. More...
NXOpen::Annotations::LeaderBuilder *	Leader ()
	Returns the leader Created in NX7.5.0. More...
NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the origin Created in NX7.5.0. More...
NXOpen::Routing::RouteObjectCollector *	RouteObjectCollector ()
	Returns the route object collector Created in NX7.5.0. More...
NXOpen::Point *	SecondEndPoint ()
	Returns the second end point Created in NX7.5.0. More...
void	SetFirstEndPoint (NXOpen::Point *firstEndPoint)
	Sets the first end point Created in NX7.5.0. More...
void	SetPathLengthAnnotationEndPoints (NXOpen::Point *firstEndPoint, NXOpen::Point *secondEndPoint)
	Create and initialize the Path Length Annotation Created in NX7.5.0. More...
void	SetSecondEndPoint (NXOpen::Point *secondEndPoint)
	Sets the second end point Created in NX7.5.0. More...
void	SetShowLeadersToggle (bool showLeadersToggle)
	Sets the show leaders toggle Created in NX7.5.0. More...
void	SetType (NXOpen::Formboard::PathLengthAnnotationBuilder::Types type)
	Sets the type Created in NX7.5.0. More...
bool	ShowLeadersToggle ()
	Returns the show leaders toggle Created in NX7.5.0. More...
NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the style Created in NX7.5.0. More...
NXOpen::Annotations::TextWithEditControlsBuilder *	Text ()
	Returns the u icomp text with symbols0 Created in NX7.5.0. More...
NXOpen::Formboard::PathLengthAnnotationBuilder::Types	Type ()
	Returns the type Created in NX7.5.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

TODO Class documentation
To create a new instance of this class, use NXOpen::Formboard::FormboardManager::CreatePathLengthAnnotationBuilder
Default values.

Property	Value
ShowLeadersToggle	0
Text.TextBlock.CustomSymbolScale	1.0
Text.TextBlock.SymbolAspectRatio	1.0
Text.TextBlock.SymbolHeight	25.4 (millimeters part), 1.0 (inches part)
Text.TextBlock.SymbolLength	25.4 (millimeters part), 1.0 (inches part)
Text.TextBlock.SymbolPreferences	UseCurrent
Text.TextBlock.SymbolScale	1.0
Text.TextBlock.SymbolSizeMethod	ScaleAndAspectRatio

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Formboard::PathLengthAnnotationBuilder::Types

TODO: Document the whole type.

Enumerator
TypesPointsOnCurves	TODO.
TypesRoutingPathLength	TODO.

Member Function Documentation

void NXOpen::Formboard::PathLengthAnnotationBuilder::CreatePointsAtRcps	(	NXOpen::Routing::ControlPoint *	firstEndRcp,
		NXOpen::Routing::ControlPoint *	secondEndRcp
	)

Create builder end points at the RCP locations
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

firstEndRcp	First Routing control point
secondEndRcp	Second Routing control point

NXString NXOpen::Formboard::PathLengthAnnotationBuilder::ExpressionName

(

)

Returns the expression name
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Point* NXOpen::Formboard::PathLengthAnnotationBuilder::FirstEndPoint

(

)

Returns the first end point
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Annotations::LeaderBuilder* NXOpen::Formboard::PathLengthAnnotationBuilder::Leader

(

)

Returns the leader
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Annotations::OriginBuilder* NXOpen::Formboard::PathLengthAnnotationBuilder::Origin

(

)

Returns the origin
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Routing::RouteObjectCollector* NXOpen::Formboard::PathLengthAnnotationBuilder::RouteObjectCollector

(

)

Returns the route object collector
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Point* NXOpen::Formboard::PathLengthAnnotationBuilder::SecondEndPoint

(

)

Returns the second end point
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::PathLengthAnnotationBuilder::SetFirstEndPoint

(

NXOpen::Point *

firstEndPoint

)

Sets the first end point
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

firstEndPoint

firstendpoint

void NXOpen::Formboard::PathLengthAnnotationBuilder::SetPathLengthAnnotationEndPoints	(	NXOpen::Point *	firstEndPoint,
		NXOpen::Point *	secondEndPoint
	)

Create and initialize the Path Length Annotation
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

firstEndPoint	First end point for the path length annotation
secondEndPoint	Second end point for the path length annotation

void NXOpen::Formboard::PathLengthAnnotationBuilder::SetSecondEndPoint

(

NXOpen::Point *

secondEndPoint

)

Sets the second end point
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

secondEndPoint

secondendpoint

void NXOpen::Formboard::PathLengthAnnotationBuilder::SetShowLeadersToggle

(

bool

showLeadersToggle

)

Sets the show leaders toggle
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

showLeadersToggle

showleaderstoggle

void NXOpen::Formboard::PathLengthAnnotationBuilder::SetType

(

NXOpen::Formboard::PathLengthAnnotationBuilder::Types

type

)

Sets the type
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

type

type

bool NXOpen::Formboard::PathLengthAnnotationBuilder::ShowLeadersToggle

(

)

Returns the show leaders toggle
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Annotations::StyleBuilder* NXOpen::Formboard::PathLengthAnnotationBuilder::Style

(

)

Returns the style
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Annotations::TextWithEditControlsBuilder* NXOpen::Formboard::PathLengthAnnotationBuilder::Text

(

)

Returns the u icomp text with symbols0
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::PathLengthAnnotationBuilder::Types NXOpen::Formboard::PathLengthAnnotationBuilder::Type

(

)

Returns the type
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

---

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

• Formboard_PathLengthAnnotationBuilder.hxx