Builder for Face Annotation functionality used in formboard. More...

Inheritance diagram for NXOpen::Formboard::FaceAnnotationBuilder:

Public Types
enum	DrwDestination { DrwDestinationDrawingSheet, DrwDestinationModel }
	Enum which defines where the geometry is to be placed. More...

enum	Types { TypesComponentAttribute, TypesCgmFileSelection, TypesPatternFileSelection }
	Enum which defines the type to import CGM/Pattern file. More...

Public Member Functions
NXString	CgmflBrsr ()
	Returns the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .

NXOpen::SelectNXObject *	CompSel ()
	Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.

NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination	DestEnum ()
	Returns the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry Created in NX7.5.0.

NXOpen::Point *	PntOrigin ()
	Returns the user selected point where geometry will be placed Created in NX7.5.0.

void	SetCgmflBrsr (const NXString &filename)
	Sets the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .

void	SetCgmflBrsr (const char *filename)
	Sets the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .

void	SetDestEnum (NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination destEnum)
	Sets the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry Created in NX7.5.0.

void	SetPntOrigin (NXOpen::Point *pntOrigin)
	Sets the user selected point where geometry will be placed Created in NX7.5.0.

void	SetStrAnnot (const NXString &strAnnot)
	Sets the string to display the name of Pattern file name selected by user.

void	SetStrAnnot (const char *strAnnot)
	Sets the string to display the name of Pattern file name selected by user.

void	SetStrAnnotFileName (const NXString &strAnnot)
	Sets the string to display the name of CGM name selected by user.

void	SetStrAnnotFileName (const char *strAnnot)
	Sets the string to display the name of CGM name selected by user.

void	SetTogBlank (bool togBlank)
	Sets the toggle which defines whether the selected component is to be blanked or not Created in NX7.5.0.

void	SetType (NXOpen::Formboard::FaceAnnotationBuilder::Types type)
	Sets the Formboard::FaceAnnotationBuilder::Types selected by user Created in NX7.5.0.

NXString	StrAnnot ()
	Returns the string to display the name of Pattern file name selected by user.

NXString	StrAnnotFileName ()
	Returns the string to display the name of CGM name selected by user.

bool	TogBlank ()
	Returns the toggle which defines whether the selected component is to be blanked or not Created in NX7.5.0.

NXOpen::Formboard::FaceAnnotationBuilder::Types	Type ()
	Returns the Formboard::FaceAnnotationBuilder::Types selected by user Created in NX7.5.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Builder for Face Annotation functionality used in formboard.

It allows importing CGM or Pattern file geometry and placing it on a drawing sheet or model view. As a result of this a group of dumb geometry is placed such that defined origin is located at the lower left hand of the bounding box containing the group of geometry.
To create a new instance of this class, use Formboard::FormboardManager::CreateFaceAnnotationBuilder
Default values.

Property

Value

DestEnum

DrawingSheet

TogBlank

0

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination

Enum which defines where the geometry is to be placed.

The geometry can be placed either in model or drawing sheet.

Enumerator:

DrwDestinationDrawingSheet	Place geometry in drawing sheet.
DrwDestinationModel	Place geometry in model.

enum NXOpen::Formboard::FaceAnnotationBuilder::Types

Enum which defines the type to import CGM/Pattern file.

Enumerator:

TypesComponentAttribute	Import CGM file by selecting a component.
TypesCgmFileSelection	Import CGM file by browsing a CGM file.
TypesPatternFileSelection	Import a pattern file.

Member Function Documentation

NXString NXOpen::Formboard::FaceAnnotationBuilder::CgmflBrsr ( )

Returns the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::SelectNXObject* NXOpen::Formboard::FaceAnnotationBuilder::CompSel ( )

Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination NXOpen::Formboard::FaceAnnotationBuilder::DestEnum ( )

Returns the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Point* NXOpen::Formboard::FaceAnnotationBuilder::PntOrigin ( )

Returns the user selected point where geometry will be placed
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::FaceAnnotationBuilder::SetCgmflBrsr ( const NXString & filename )

Sets the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

filename filename

void NXOpen::Formboard::FaceAnnotationBuilder::SetCgmflBrsr ( const char * filename )

Sets the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

filename filename

void NXOpen::Formboard::FaceAnnotationBuilder::SetDestEnum ( NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination destEnum )

Sets the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

destEnum destenum

void NXOpen::Formboard::FaceAnnotationBuilder::SetPntOrigin ( NXOpen::Point * pntOrigin )

Sets the user selected point where geometry will be placed
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

pntOrigin pntorigin

void NXOpen::Formboard::FaceAnnotationBuilder::SetStrAnnot ( const NXString & strAnnot )

Sets the string to display the name of Pattern file name selected by user.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

strAnnot strannot

void NXOpen::Formboard::FaceAnnotationBuilder::SetStrAnnot ( const char * strAnnot )

Sets the string to display the name of Pattern file name selected by user.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

strAnnot strannot

void NXOpen::Formboard::FaceAnnotationBuilder::SetStrAnnotFileName ( const NXString & strAnnot )

Sets the string to display the name of CGM name selected by user.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

strAnnot strannot

void NXOpen::Formboard::FaceAnnotationBuilder::SetStrAnnotFileName ( const char * strAnnot )

Sets the string to display the name of CGM name selected by user.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

strAnnot strannot

void NXOpen::Formboard::FaceAnnotationBuilder::SetTogBlank ( bool togBlank )

Sets the toggle which defines whether the selected component is to be blanked or not
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

togBlank togblank

void NXOpen::Formboard::FaceAnnotationBuilder::SetType ( NXOpen::Formboard::FaceAnnotationBuilder::Types type )

Sets the Formboard::FaceAnnotationBuilder::Types selected by user
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

type type

NXString NXOpen::Formboard::FaceAnnotationBuilder::StrAnnot ( )

Returns the string to display the name of Pattern file name selected by user.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXString NXOpen::Formboard::FaceAnnotationBuilder::StrAnnotFileName ( )

Returns the string to display the name of CGM name selected by user.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

bool NXOpen::Formboard::FaceAnnotationBuilder::TogBlank ( )

Returns the toggle which defines whether the selected component is to be blanked or not
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::FaceAnnotationBuilder::Types NXOpen::Formboard::FaceAnnotationBuilder::Type ( )

Returns the Formboard::FaceAnnotationBuilder::Types selected by user
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

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

Formboard_FaceAnnotationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation