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

Represents a Builder for Insert Component functionality which will insert a 2D Component instance in the active sketch
To create a new instance of this class, use Layout2d::ComponentCollection::CreateInsertComponentBuilder

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Layout2d::InsertComponentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void SetLocation (NXOpen::Layout2d::Layout2dDefinitionLocation locationType)
 Sets the location type of the component indicating local, native or team center
Created in NX9.0.0.
 
void SetPath (const NXString &path)
 Sets the path of the reuse library for the component
Created in NX9.0.0.
 
void SetPath (const char *path)
 Sets the path of the reuse library for the component
Created in NX9.0.0.
 
void SetSketch (NXOpen::Sketch *sketch)
 Sets the sketch to insert the component
Created in NX9.0.0.
 
void SetSpecifyPoint (const NXOpen::Point3d &specifyPoint)
 Sets the point specified to put the 2D component instance
Created in NX9.0.0.
 
NXOpen::Layout2d::ComponentSettingsBlockBuilderSettings ()
 Returns the Component settings block builder which holds the component settings builder
Created in NX9.0.0.
 
NXOpen::SketchSketch ()
 Returns the sketch to insert the component
Created in NX9.0.0.
 
NXOpen::Point3d SpecifyPoint ()
 Returns the point specified to put the 2D component instance
Created in NX9.0.0.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

Represents a Builder for Insert Component functionality which will insert a 2D Component instance in the active sketch
To create a new instance of this class, use Layout2d::ComponentCollection::CreateInsertComponentBuilder

Created in NX9.0.0.


Member Function Documentation

void NXOpen::Layout2d::InsertComponentBuilder::SetLocation ( NXOpen::Layout2d::Layout2dDefinitionLocation  locationType)

Sets the location type of the component indicating local, native or team center
Created in NX9.0.0.



License requirements : nx_drafting_plus ("DraftingPlus")

Parameters
locationTypelocationtype
void NXOpen::Layout2d::InsertComponentBuilder::SetPath ( const NXString path)

Sets the path of the reuse library for the component
Created in NX9.0.0.



License requirements : nx_drafting_plus ("DraftingPlus")

Parameters
pathlocation of component
void NXOpen::Layout2d::InsertComponentBuilder::SetPath ( const char *  path)

Sets the path of the reuse library for the component
Created in NX9.0.0.



License requirements : nx_drafting_plus ("DraftingPlus")

Parameters
pathlocation of component
void NXOpen::Layout2d::InsertComponentBuilder::SetSketch ( NXOpen::Sketch sketch)

Sets the sketch to insert the component
Created in NX9.0.0.



License requirements : nx_drafting_plus ("DraftingPlus")

Parameters
sketchsketch
void NXOpen::Layout2d::InsertComponentBuilder::SetSpecifyPoint ( const NXOpen::Point3d specifyPoint)

Sets the point specified to put the 2D component instance
Created in NX9.0.0.



License requirements : nx_drafting_plus ("DraftingPlus")

Parameters
specifyPointspecifypoint
NXOpen::Layout2d::ComponentSettingsBlockBuilder* NXOpen::Layout2d::InsertComponentBuilder::Settings ( )

Returns the Component settings block builder which holds the component settings builder
Created in NX9.0.0.



License requirements : None

NXOpen::Sketch* NXOpen::Layout2d::InsertComponentBuilder::Sketch ( )

Returns the sketch to insert the component
Created in NX9.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Layout2d::InsertComponentBuilder::SpecifyPoint ( )

Returns the point specified to put the 2D component instance
Created in NX9.0.0.



License requirements : None


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