NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder Class Reference

Represents a Symbol2DBuilder. More...

Inheritance diagram for NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Point2d AnchorPoint ()
 Returns the anchor point
Created in NX11.0.1. More...
 
void CreateFromSymbol (const NXString &symbolId)
 Creates a new symbol from another symbol
Created in NX11.0.1. More...
 
void CreateFromSymbol (const char *symbolId)
 Creates a new symbol from another symbol
Created in NX11.0.1. More...
 
NXOpen::Tooling::SelectReuseLibraryItemBuilderDraftingSymbol ()
 Returns the 2D symbol sub-builder. More...
 
bool EnableScale ()
 Returns the scaling
Created in NX11.0.1. More...
 
NXOpen::Gateway::ImageCaptureBuilderImage ()
 Returns the image capture builder
Created in NX11.0.1. More...
 
bool IsInline ()
 Returns the inline
Created in NX11.0.1. More...
 
NXOpen::DiagrammingLibraryAuthor::PortDataBuilderPortData ()
 Returns the port data sub-builder. More...
 
void SetAnchorPoint (const NXOpen::Point2d &anchorPoint)
 Sets the anchor point
Created in NX11.0.1. More...
 
void SetEnableScale (bool enableScale)
 Sets the scaling
Created in NX11.0.1. More...
 
void SetImage (NXOpen::Gateway::ImageCaptureBuilder *imageCaptureBuilder)
 Sets the image capture builder
Created in NX11.0.1. More...
 
void SetInline (bool isInline)
 Sets the inline
Created in NX11.0.1. More...
 
void SetTagLocation (const NXOpen::Point2d &tagLocation)
 Sets the tag location
Created in NX11.0.1. More...
 
NXOpen::Point2d TagLocation ()
 Returns the tag location
Created in NX11.0.1. 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 Symbol2DBuilder.


Created in NX11.0.1.

Member Function Documentation

NXOpen::Point2d NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::AnchorPoint ( )

Returns the anchor point
Created in NX11.0.1.



License requirements : None

void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::CreateFromSymbol ( const NXString symbolId)

Creates a new symbol from another symbol
Created in NX11.0.1.



License requirements : None

Parameters
symbolIdsymbolid
void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::CreateFromSymbol ( const char *  symbolId)

Creates a new symbol from another symbol
Created in NX11.0.1.



License requirements : None

Parameters
symbolIdsymbolid
NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::DraftingSymbol ( )

Returns the 2D symbol sub-builder.


Created in NX12.0.0.

License requirements : None

bool NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::EnableScale ( )

Returns the scaling
Created in NX11.0.1.



License requirements : None

NXOpen::Gateway::ImageCaptureBuilder* NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::Image ( )

Returns the image capture builder
Created in NX11.0.1.



License requirements : None

bool NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::IsInline ( )

Returns the inline
Created in NX11.0.1.



License requirements : None

NXOpen::DiagrammingLibraryAuthor::PortDataBuilder* NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::PortData ( )

Returns the port data sub-builder.


Created in NX11.0.1.

License requirements : None

void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::SetAnchorPoint ( const NXOpen::Point2d anchorPoint)

Sets the anchor point
Created in NX11.0.1.



License requirements : None

Parameters
anchorPointanchorpoint
void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::SetEnableScale ( bool  enableScale)

Sets the scaling
Created in NX11.0.1.



License requirements : None

Parameters
enableScaleenablescale
void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::SetImage ( NXOpen::Gateway::ImageCaptureBuilder imageCaptureBuilder)

Sets the image capture builder
Created in NX11.0.1.



License requirements : None

Parameters
imageCaptureBuilderimagecapturebuilder
void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::SetInline ( bool  isInline)

Sets the inline
Created in NX11.0.1.



License requirements : None

Parameters
isInlineisinline
void NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::SetTagLocation ( const NXOpen::Point2d tagLocation)

Sets the tag location
Created in NX11.0.1.



License requirements : None

Parameters
tagLocationtaglocation
NXOpen::Point2d NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::TagLocation ( )

Returns the tag location
Created in NX11.0.1.



License requirements : None

virtual bool NXOpen::DiagrammingLibraryAuthor::Symbol2DBuilder::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.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.