Represents a Symbol Authoring class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateSymbolAuthoringBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::SymbolAuthoringBuilder:

Public Types
enum	Types { TypesStandardSymbol, TypesCableDefinitionLine }
	Represents the type of symbol. More...

Public Member Functions
NXOpen::Point2d	AnchorPointLocation ()
	Returns the symbol anchor point Created in NX12.0.0. More...

NXOpen::Gateway::ImageCaptureBuilder *	CapturedImage ()
	Returns the image capture builder used to create an image for preview Created in NX12.0.0. More...

NXOpen::NXObject *	CreateConnectionPoint (NXOpen::NXObject *portToBeMapped)
	Creates a new connection point. More...

void	DeleteConnectionPoint (NXOpen::NXObject portToBeUnmapped, NXOpen::NXObject libPort)
	Deletes the connection point Created in NX12.0.0. More...

NXOpen::Point2d	GetConnectionDirection (NXOpen::NXObject *libPort)
	Gets the connection direction. More...

NXOpen::Point2d	GetConnectionPointLocation (NXOpen::NXObject *libPort)
	Gets the connection point location. More...

NXOpen::Annotations::CustomSymbol *	InsertSymbol (const NXString &customSymbolPath)
	Insert the symbol. More...

NXOpen::Annotations::CustomSymbol *	InsertSymbol (const char *customSymbolPath)
	Insert the symbol. More...

NXOpen::Tooling::SelectReuseLibraryItemBuilder *	SelectedCustomSymbol ()
	Returns the custom symbol selection Created in NX12.0.0. More...

NXOpen::AME::SelectAMEPort *	SelectedPort ()
	Returns the port selection Created in NX12.0.0. More...

void	SetAnchorPointLocation (const NXOpen::Point2d &symbolAnchorPoint)
	Sets the symbol anchor point Created in NX12.0.0. More...

NXOpen::Point2d	SetConnectionDirection (NXOpen::NXObject *libPort)
	Sets the connection direction. More...

NXOpen::Point2d	SetConnectionPointLocation (NXOpen::NXObject *libPort)
	Sets the connection point location. More...

void	SetType (NXOpen::AME::SymbolAuthoringBuilder::Types type)
	Sets the symbol type Created in NX12.0.0. More...

NXOpen::Point2d	SymbolAnnotationPoint ()
	Returns the symbol annotation point Created in NX12.0.0. More...

NXOpen::AME::SymbolAuthoringBuilder::Types	Type ()
	Returns the symbol type Created in NX12.0.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

Represents a Symbol Authoring class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateSymbolAuthoringBuilder
Default values.

Property

Value

CapturedImage.CaptureMethod

GraphicsArea

CapturedImage.Format

Bmp

CapturedImage.Size

Pixels64

Type

StandardSymbol

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::AME::SymbolAuthoringBuilder::Types

Represents the type of symbol.

Enumerator
TypesStandardSymbol	standard symbol
TypesCableDefinitionLine	cable definition line

Member Function Documentation

NXOpen::Point2d NXOpen::AME::SymbolAuthoringBuilder::AnchorPointLocation ( )

Returns the symbol anchor point
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Gateway::ImageCaptureBuilder* NXOpen::AME::SymbolAuthoringBuilder::CapturedImage ( )

Returns the image capture builder used to create an image for preview
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::NXObject* NXOpen::AME::SymbolAuthoringBuilder::CreateConnectionPoint ( NXOpen::NXObject * portToBeMapped )

Creates a new connection point.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

portToBeMapped porttobemapped

void NXOpen::AME::SymbolAuthoringBuilder::DeleteConnectionPoint	(	NXOpen::NXObject *	portToBeUnmapped,
		NXOpen::NXObject *	libPort
	)

Deletes the connection point
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

portToBeUnmapped	porttobeunmapped
libPort	libport

NXOpen::Point2d NXOpen::AME::SymbolAuthoringBuilder::GetConnectionDirection ( NXOpen::NXObject * libPort )

Gets the connection direction.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

libPort libport

NXOpen::Point2d NXOpen::AME::SymbolAuthoringBuilder::GetConnectionPointLocation ( NXOpen::NXObject * libPort )

Gets the connection point location.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

libPort libport

NXOpen::Annotations::CustomSymbol* NXOpen::AME::SymbolAuthoringBuilder::InsertSymbol ( const NXString & customSymbolPath )

Insert the symbol.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

customSymbolPath customsymbolpath

NXOpen::Annotations::CustomSymbol* NXOpen::AME::SymbolAuthoringBuilder::InsertSymbol ( const char * customSymbolPath )

Insert the symbol.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

customSymbolPath customsymbolpath

NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::SymbolAuthoringBuilder::SelectedCustomSymbol ( )

Returns the custom symbol selection
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEPort* NXOpen::AME::SymbolAuthoringBuilder::SelectedPort ( )

Returns the port selection
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolAuthoringBuilder::SetAnchorPointLocation ( const NXOpen::Point2d & symbolAnchorPoint )

Sets the symbol anchor point
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

symbolAnchorPoint symbolanchorpoint

NXOpen::Point2d NXOpen::AME::SymbolAuthoringBuilder::SetConnectionDirection ( NXOpen::NXObject * libPort )

Sets the connection direction.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

libPort libport

NXOpen::Point2d NXOpen::AME::SymbolAuthoringBuilder::SetConnectionPointLocation ( NXOpen::NXObject * libPort )

Sets the connection point location.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

libPort libport

void NXOpen::AME::SymbolAuthoringBuilder::SetType ( NXOpen::AME::SymbolAuthoringBuilder::Types type )

Sets the symbol type
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

type type

NXOpen::Point2d NXOpen::AME::SymbolAuthoringBuilder::SymbolAnnotationPoint ( )

Returns the symbol annotation point
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SymbolAuthoringBuilder::Types NXOpen::AME::SymbolAuthoringBuilder::Type ( )

Returns the symbol type
Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

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

AME_SymbolAuthoringBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation