NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Drawings::DraftingComponentSelectionBuilder Class Reference

This builder allows the user to select a view in which component objects can be designated as primary or secondary geometry
Created in NX11.0.0. More...

Inheritance diagram for NXOpen::Drawings::DraftingComponentSelectionBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Geometry { GeometryPrimaryGeometry, GeometrySecondaryGeometry }
 type of geometry More...
 

Public Member Functions

void ClearSecondaryComponentList ()
 Clears the secondary component list. More...
 
void InitializeListFromObject (NXOpen::NXObject *inputObject)
 Initialize list of components from the input object's components list. More...
 
NXOpen::SelectNXObjectListObjects ()
 Returns the selected objects (part occurrences) based on current object type
Created in NX11.0.0. More...
 
NXOpen::Drawings::DraftingComponentSelectionBuilder::Geometry ObjectType ()
 Returns the object type
Created in NX11.0.0. More...
 
NXOpen::PartPart ()
 Returns the part to use for populating the primary and secondary components object list
Created in NX11.0.0. More...
 
NXOpen::PartPartForKF ()
 Returns the part to use for populating the primary and secondary components object list
Created in NX11.0.0. More...
 
void ResetListToGlobal ()
 Reset list of components to those specified by Properties->Drawings->Secondary Geometry
Created in NX11.0.0. More...
 
void SetObjectType (NXOpen::Drawings::DraftingComponentSelectionBuilder::Geometry objectType)
 Sets the object type
Created in NX11.0.0. More...
 
void SetPart (NXOpen::Part *part)
 Sets the part to use for populating the primary and secondary components object list
Created in NX11.0.0. 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

This builder allows the user to select a view in which component objects can be designated as primary or secondary geometry
Created in NX11.0.0.


Member Enumeration Documentation

type of geometry

Enumerator
GeometryPrimaryGeometry 

indicates the component objects are to be rendered with Primary geometry color/font/width

GeometrySecondaryGeometry 

indicates the component objects are to be rendered with Secondary geometry color/font/width

Member Function Documentation

void NXOpen::Drawings::DraftingComponentSelectionBuilder::ClearSecondaryComponentList ( )

Clears the secondary component list.


Created in NX11.0.0.

License requirements : None

void NXOpen::Drawings::DraftingComponentSelectionBuilder::InitializeListFromObject ( NXOpen::NXObject inputObject)

Initialize list of components from the input object's components list.


Created in NX11.0.0.

License requirements : None

Parameters
inputObjectinputobject
NXOpen::SelectNXObjectList* NXOpen::Drawings::DraftingComponentSelectionBuilder::Objects ( )

Returns the selected objects (part occurrences) based on current object type
Created in NX11.0.0.



License requirements : None

NXOpen::Drawings::DraftingComponentSelectionBuilder::Geometry NXOpen::Drawings::DraftingComponentSelectionBuilder::ObjectType ( )

Returns the object type
Created in NX11.0.0.



License requirements : None

NXOpen::Part* NXOpen::Drawings::DraftingComponentSelectionBuilder::Part ( )

Returns the part to use for populating the primary and secondary components object list
Created in NX11.0.0.



License requirements : None

NXOpen::Part* NXOpen::Drawings::DraftingComponentSelectionBuilder::PartForKF ( )

Returns the part to use for populating the primary and secondary components object list
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::DraftingComponentSelectionBuilder::ResetListToGlobal ( )

Reset list of components to those specified by Properties->Drawings->Secondary Geometry
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::DraftingComponentSelectionBuilder::SetObjectType ( NXOpen::Drawings::DraftingComponentSelectionBuilder::Geometry  objectType)

Sets the object type
Created in NX11.0.0.



License requirements : None

Parameters
objectTypeobjecttype
void NXOpen::Drawings::DraftingComponentSelectionBuilder::SetPart ( NXOpen::Part part)

Sets the part to use for populating the primary and secondary components object list
Created in NX11.0.0.



License requirements : None

Parameters
partpart
virtual bool NXOpen::Drawings::DraftingComponentSelectionBuilder::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.