NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::Subdivision::DefineWorkRegionBuilder Class Reference

Represents a Features::Subdivision::DefineWorkRegionBuilder builder. More...

Inheritance diagram for NXOpen::Features::Subdivision::DefineWorkRegionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FrozenRegionDefinitionMethods { FrozenRegionDefinitionMethodsHidden, FrozenRegionDefinitionMethodsColored }
 Method of defining frozen region. More...
 
enum  WorkRegionDefinitionMethods { WorkRegionDefinitionMethodsAll, WorkRegionDefinitionMethodsSelected }
 Method of defining work region. More...
 

Public Member Functions

NXOpen::NXColorFrozenColor ()
 Returns the frozen region color
Created in NX11.0.0. More...
 
NXOpen::Features::Subdivision::DefineWorkRegionBuilder::FrozenRegionDefinitionMethods FrozenRegionDefinitionMethod ()
 Returns the frozen region method
Created in NX11.0.0. More...
 
void SetFrozenColor (NXOpen::NXColor *frozenColor)
 Sets the frozen region color
Created in NX11.0.0. More...
 
void SetFrozenRegionDefinitionMethod (NXOpen::Features::Subdivision::DefineWorkRegionBuilder::FrozenRegionDefinitionMethods frozenRegionDefinitionMethod)
 Sets the frozen region method
Created in NX11.0.0. More...
 
void SetWorkRegionDefinitionMethod (NXOpen::Features::Subdivision::DefineWorkRegionBuilder::WorkRegionDefinitionMethods workRegionDefinitionMethod)
 Sets the work region definition method
Created in NX11.0.0. More...
 
NXOpen::Features::Subdivision::DefineWorkRegionBuilder::WorkRegionDefinitionMethods WorkRegionDefinitionMethod ()
 Returns the work region definition method
Created in NX11.0.0. More...
 
NXOpen::Features::Subdivision::SelectCageObjectDataWorkRegionObjects ()
 Returns the work region objects
Created in NX11.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 Features::Subdivision::DefineWorkRegionBuilder builder.


To create a new instance of this class, use NXOpen::Features::Subdivision::SubdivisionBodyCollection::CreateDefineWorkRegionBuilder

Created in NX11.0.0.

Member Enumeration Documentation

Method of defining frozen region.

Enumerator
FrozenRegionDefinitionMethodsHidden 

Do not display the frozen region.

FrozenRegionDefinitionMethodsColored 

Mark frozen region with color and do not allow its selection.

Method of defining work region.

Enumerator
WorkRegionDefinitionMethodsAll 

Treat all the region as work region.

WorkRegionDefinitionMethodsSelected 

Specify a region as work region.

Member Function Documentation

NXOpen::NXColor* NXOpen::Features::Subdivision::DefineWorkRegionBuilder::FrozenColor ( )

Returns the frozen region color
Created in NX11.0.0.



License requirements : None

NXOpen::Features::Subdivision::DefineWorkRegionBuilder::FrozenRegionDefinitionMethods NXOpen::Features::Subdivision::DefineWorkRegionBuilder::FrozenRegionDefinitionMethod ( )

Returns the frozen region method
Created in NX11.0.0.



License requirements : None

void NXOpen::Features::Subdivision::DefineWorkRegionBuilder::SetFrozenColor ( NXOpen::NXColor frozenColor)

Sets the frozen region color
Created in NX11.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
frozenColorfrozencolor
void NXOpen::Features::Subdivision::DefineWorkRegionBuilder::SetFrozenRegionDefinitionMethod ( NXOpen::Features::Subdivision::DefineWorkRegionBuilder::FrozenRegionDefinitionMethods  frozenRegionDefinitionMethod)

Sets the frozen region method
Created in NX11.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
frozenRegionDefinitionMethodfrozenregiondefinitionmethod
void NXOpen::Features::Subdivision::DefineWorkRegionBuilder::SetWorkRegionDefinitionMethod ( NXOpen::Features::Subdivision::DefineWorkRegionBuilder::WorkRegionDefinitionMethods  workRegionDefinitionMethod)

Sets the work region definition method
Created in NX11.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
workRegionDefinitionMethodworkregiondefinitionmethod
NXOpen::Features::Subdivision::DefineWorkRegionBuilder::WorkRegionDefinitionMethods NXOpen::Features::Subdivision::DefineWorkRegionBuilder::WorkRegionDefinitionMethod ( )

Returns the work region definition method
Created in NX11.0.0.



License requirements : None

NXOpen::Features::Subdivision::SelectCageObjectData* NXOpen::Features::Subdivision::DefineWorkRegionBuilder::WorkRegionObjects ( )

Returns the work region objects
Created in NX11.0.0.



License requirements : None


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