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

Represents a Builder for Define 2D component functionality which will define a 2D Component and stores its definition in the Reuse Library
To create a new instance of this class, use NXOpen::Layout2d::ComponentCollection::CreateDefineComponentBuilder
Default values. More...

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

Public Member Functions

NXOpen::PointAnchorPoint ()
 Returns the anchor point to define the 2D Component
Created in NX10.0.0. More...
 
NXOpen::Layout2d::ComponentNameBuilderComponentName ()
 Returns the 2D Component Name defines the name for the new created definition
Created in NX10.0.0. More...
 
NXOpen::SelectNXObjectListContents ()
 Returns the select objects to create a 2D Component definition
Created in NX10.0.0. More...
 
NXOpen::Gateway::ImageCaptureBuilderImageCapture ()
 Returns the image capture builder used to create an image for the definition
Created in NX10.0.0. More...
 
NXString ImageName ()
 Returns the 2D Component image name for the new created definition
Created in NX10.0.0. More...
 
void SetAnchorPoint (NXOpen::Point *anchorPoint)
 Sets the anchor point to define the 2D Component
Created in NX10.0.0. More...
 
void SetImageName (const NXString &imageName)
 Sets the 2D Component image name for the new created definition
Created in NX10.0.0. More...
 
void SetImageName (const char *imageName)
 Sets the 2D Component image name for the new created definition
Created in NX10.0.0. More...
 
void SetLocation (NXOpen::Layout2d::Layout2dDefinitionLocation locationType)
 Sets the location type of the component indicating local, native or team center
Created in NX10.0.0. More...
 
void SetPath (const NXString &path)
 Sets the path to store the 2D Component
Created in NX10.0.0. More...
 
void SetPath (const char *path)
 Sets the path to store the 2D Component
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 Builder for Define 2D component functionality which will define a 2D Component and stores its definition in the Reuse Library
To create a new instance of this class, use NXOpen::Layout2d::ComponentCollection::CreateDefineComponentBuilder
Default values.

Property Value

ImageCapture.CaptureMethod

GraphicsArea

ImageCapture.Format

Bmp

ImageCapture.Size

Pixels64


Created in NX10.0.0.

Member Function Documentation

NXOpen::Point* NXOpen::Layout2d::DefineComponentBuilder::AnchorPoint ( )

Returns the anchor point to define the 2D Component
Created in NX10.0.0.



License requirements : None

NXOpen::Layout2d::ComponentNameBuilder* NXOpen::Layout2d::DefineComponentBuilder::ComponentName ( )

Returns the 2D Component Name defines the name for the new created definition
Created in NX10.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Layout2d::DefineComponentBuilder::Contents ( )

Returns the select objects to create a 2D Component definition
Created in NX10.0.0.



License requirements : None

NXOpen::Gateway::ImageCaptureBuilder* NXOpen::Layout2d::DefineComponentBuilder::ImageCapture ( )

Returns the image capture builder used to create an image for the definition
Created in NX10.0.0.



License requirements : None

NXString NXOpen::Layout2d::DefineComponentBuilder::ImageName ( )

Returns the 2D Component image name for the new created definition
Created in NX10.0.0.



License requirements : None

void NXOpen::Layout2d::DefineComponentBuilder::SetAnchorPoint ( NXOpen::Point anchorPoint)

Sets the anchor point to define the 2D Component
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
anchorPointanchorpoint
void NXOpen::Layout2d::DefineComponentBuilder::SetImageName ( const NXString imageName)

Sets the 2D Component image name for the new created definition
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
imageNameimagename
void NXOpen::Layout2d::DefineComponentBuilder::SetImageName ( const char *  imageName)

Sets the 2D Component image name for the new created definition
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
imageNameimagename
void NXOpen::Layout2d::DefineComponentBuilder::SetLocation ( NXOpen::Layout2d::Layout2dDefinitionLocation  locationType)

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



License requirements : nx_layout ("NX Layout")

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

Sets the path to store the 2D Component
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

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

Sets the path to store the 2D Component
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
pathlocation of component

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