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

Represents a Select Region Selection block
Created in NX12.0.0. More...

Inheritance diagram for NXOpen::BlockStyler::SelectFacetRegion:
NXOpen::BlockStyler::UIBlock NXOpen::TaggedObject

Public Member Functions

bool AutomaticProgression ()
 Returns the AutomaticProgression
Created in NX12.0.0. More...
 
NXString BalloonTooltipImage ()
 Returns the BalloonTooltipImage
Created in NX12.0.0. More...
 
NXString BalloonTooltipLayoutAsString ()
 Returns the BalloonTooltipLayout as string
Created in NX12.0.0. More...
 
NXString BalloonTooltipText ()
 Returns the BalloonTooltipText
Created in NX12.0.0. More...
 
NXString Bitmap ()
 Returns the Bitmap
Created in NX12.0.0. More...
 
NXString Cue ()
 Returns the Cue
Created in NX12.0.0. More...
 
int EnabledFacetCollectionRules ()
 Returns the FacetCollectionRules. More...
 
NXOpen::FacetCollectorFacetCollector ()
 Returns the OwningFacetCollector. More...
 
std::vector< NXStringGetBalloonTooltipLayoutMembers ()
 Gets the BalloonTooltipLayout members. More...
 
std::vector
< NXOpen::TaggedObject * > 
GetLastDeselectedObjects ()
 Gets the LastDeselectedFacetRegions. More...
 
std::vector
< NXOpen::TaggedObject * > 
GetLastSelectedObjects ()
 Gets the LastSelectedFacetRegions. More...
 
std::vector
< NXOpen::TaggedObject * > 
GetSelectedObjects ()
 Gets the SelectedFacetRegions. More...
 
std::vector< NXStringGetStepStatusMembers ()
 Gets the StepStatus members. More...
 
NXString LabelString ()
 Returns the LabelString
Created in NX12.0.0. More...
 
int SelectedFacetCollectionRule ()
 Returns the active facet collection rule
Created in NX12.0.0. More...
 
void SetAutomaticProgression (bool automaticProgression)
 Sets the AutomaticProgression
Created in NX12.0.0. More...
 
void SetBalloonTooltipImage (const NXString &imageString)
 Sets the BalloonTooltipImage
Created in NX12.0.0. More...
 
void SetBalloonTooltipImage (const char *imageString)
 Sets the BalloonTooltipImage
Created in NX12.0.0. More...
 
void SetBalloonTooltipLayoutAsString (const NXString &enumString)
 Sets the BalloonTooltipLayout as string
Created in NX12.0.0. More...
 
void SetBalloonTooltipLayoutAsString (const char *enumString)
 Sets the BalloonTooltipLayout as string
Created in NX12.0.0. More...
 
void SetBalloonTooltipText (const NXString &balloonTooltipText)
 Sets the BalloonTooltipText
Created in NX12.0.0. More...
 
void SetBalloonTooltipText (const char *balloonTooltipText)
 Sets the BalloonTooltipText
Created in NX12.0.0. More...
 
void SetBitmap (const NXString &bitmapString)
 Sets the Bitmap
Created in NX12.0.0. More...
 
void SetBitmap (const char *bitmapString)
 Sets the Bitmap
Created in NX12.0.0. More...
 
void SetCue (const NXString &cue)
 Sets the Cue
Created in NX12.0.0. More...
 
void SetCue (const char *cue)
 Sets the Cue
Created in NX12.0.0. More...
 
void SetEnabledFacetCollectionRules (int rulesEnabled)
 Sets the FacetCollectionRules. More...
 
void SetFacetCollector (NXOpen::FacetCollector *facetCollector)
 Sets the OwningFacetCollector. More...
 
void SetLabelString (const NXString &labelString)
 Sets the LabelString
Created in NX12.0.0. More...
 
void SetLabelString (const char *labelString)
 Sets the LabelString
Created in NX12.0.0. More...
 
void SetSelectedFacetCollectionRule (int selectedRule)
 Sets the active facet collection rule
Created in NX12.0.0. More...
 
void SetSelectedObjects (const std::vector< NXOpen::TaggedObject * > &objectVector)
 Sets the SelectedFacetRegions
Created in NX12.0.0. More...
 
void SetStepStatusAsString (const NXString &enumString)
 Sets the StepStatus as string
Created in NX12.0.0. More...
 
void SetStepStatusAsString (const char *enumString)
 Sets the StepStatus as string
Created in NX12.0.0. More...
 
void SetSupportedFacetTypes (int typesEnabled)
 Sets the SupportedFacetTypes. More...
 
void SetToolTip (const NXString &toolTip)
 Sets the ToolTip
Created in NX12.0.0. More...
 
void SetToolTip (const char *toolTip)
 Sets the ToolTip
Created in NX12.0.0. More...
 
NXString StepStatusAsString ()
 Returns the StepStatus as string
Created in NX12.0.0. More...
 
int SupportedFacetTypes ()
 Returns the SupportedFacetTypes. More...
 
NXString ToolTip ()
 Returns the ToolTip
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool Enable ()
 Returns the Enable. More...
 
bool Expanded ()
 Returns the Expanded
Created in NX8.5.0. More...
 
void Focus ()
 Focuses on the block. More...
 
NXOpen::BlockStyler::PropertyListGetProperties ()
 Returns the properties of the block. More...
 
bool Group ()
 Returns the Group
Created in NX8.5.0. More...
 
NXString Label ()
 Returns the Label
Created in NX8.5.0. More...
 
NXString Name ()
 Returns the name of the block or BlockID
Created in NX6.0.0. More...
 
void SetEnable (bool enable)
 Sets the Enable. More...
 
void SetExpanded (bool expanded)
 Sets the Expanded
Created in NX8.5.0. More...
 
void SetGroup (bool group)
 Sets the Group
Created in NX8.5.0. More...
 
void SetLabel (const NXString &label)
 Sets the Label
Created in NX8.5.0. More...
 
void SetLabel (const char *label)
 Sets the Label
Created in NX8.5.0. More...
 
void SetShow (bool show)
 Sets the Visibility of block. More...
 
bool Show ()
 Returns the Visibility of block. More...
 
NXString Type ()
 Returns the type of block
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Select Region Selection block
Created in NX12.0.0.


Member Function Documentation

bool NXOpen::BlockStyler::SelectFacetRegion::AutomaticProgression ( )

Returns the AutomaticProgression
Created in NX12.0.0.



License requirements : None

NXString NXOpen::BlockStyler::SelectFacetRegion::BalloonTooltipImage ( )

Returns the BalloonTooltipImage
Created in NX12.0.0.



License requirements : None

NXString NXOpen::BlockStyler::SelectFacetRegion::BalloonTooltipLayoutAsString ( )

Returns the BalloonTooltipLayout as string
Created in NX12.0.0.



License requirements : None

NXString NXOpen::BlockStyler::SelectFacetRegion::BalloonTooltipText ( )

Returns the BalloonTooltipText
Created in NX12.0.0.



License requirements : None

NXString NXOpen::BlockStyler::SelectFacetRegion::Bitmap ( )

Returns the Bitmap
Created in NX12.0.0.



License requirements : None

NXString NXOpen::BlockStyler::SelectFacetRegion::Cue ( )

Returns the Cue
Created in NX12.0.0.



License requirements : None

int NXOpen::BlockStyler::SelectFacetRegion::EnabledFacetCollectionRules ( )

Returns the FacetCollectionRules.

These are the selection intent rules enabled for the facet selection region block

It returns the following bit values,

  1. 0x1 if only Single Facet rule is enabled,
  2. 0x2 if only Face Facets rule is enabled,
  3. 0x3 if only Flood Fill rule is enabled,
  4. 0x4 if only Color Region rule is enabled


Created in NX12.0.0.

License requirements : None

NXOpen::FacetCollector* NXOpen::BlockStyler::SelectFacetRegion::FacetCollector ( )

Returns the OwningFacetCollector.

The owning facet collector is an object of class FacetCollector that holds collected facets of the block


Created in NX12.0.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SelectFacetRegion::GetBalloonTooltipLayoutMembers ( )

Gets the BalloonTooltipLayout members.

Returns
Value to get from the property.
Created in NX12.0.0.

License requirements : None
std::vector<NXOpen::TaggedObject *> NXOpen::BlockStyler::SelectFacetRegion::GetLastDeselectedObjects ( )

Gets the LastDeselectedFacetRegions.

Returns
Value to get from the property
Created in NX12.0.0.

License requirements : None
std::vector<NXOpen::TaggedObject *> NXOpen::BlockStyler::SelectFacetRegion::GetLastSelectedObjects ( )

Gets the LastSelectedFacetRegions.

Returns
Value to get from the property
Created in NX12.0.0.

License requirements : None
std::vector<NXOpen::TaggedObject *> NXOpen::BlockStyler::SelectFacetRegion::GetSelectedObjects ( )

Gets the SelectedFacetRegions.

Returns
Value to get from the property
Created in NX12.0.0.

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::SelectFacetRegion::GetStepStatusMembers ( )

Gets the StepStatus members.

Returns
Value to get from the property
Created in NX12.0.0.

License requirements : None
NXString NXOpen::BlockStyler::SelectFacetRegion::LabelString ( )

Returns the LabelString
Created in NX12.0.0.



License requirements : None

int NXOpen::BlockStyler::SelectFacetRegion::SelectedFacetCollectionRule ( )

Returns the active facet collection rule
Created in NX12.0.0.



License requirements : None

void NXOpen::BlockStyler::SelectFacetRegion::SetAutomaticProgression ( bool  automaticProgression)

Sets the AutomaticProgression
Created in NX12.0.0.



License requirements : None

Parameters
automaticProgressionautomaticprogression
void NXOpen::BlockStyler::SelectFacetRegion::SetBalloonTooltipImage ( const NXString imageString)

Sets the BalloonTooltipImage
Created in NX12.0.0.



License requirements : None

Parameters
imageStringimage string
void NXOpen::BlockStyler::SelectFacetRegion::SetBalloonTooltipImage ( const char *  imageString)

Sets the BalloonTooltipImage
Created in NX12.0.0.



License requirements : None

Parameters
imageStringimage string
void NXOpen::BlockStyler::SelectFacetRegion::SetBalloonTooltipLayoutAsString ( const NXString enumString)

Sets the BalloonTooltipLayout as string
Created in NX12.0.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::SelectFacetRegion::SetBalloonTooltipLayoutAsString ( const char *  enumString)

Sets the BalloonTooltipLayout as string
Created in NX12.0.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::SelectFacetRegion::SetBalloonTooltipText ( const NXString balloonTooltipText)

Sets the BalloonTooltipText
Created in NX12.0.0.



License requirements : None

Parameters
balloonTooltipTextballoon tooltip text
void NXOpen::BlockStyler::SelectFacetRegion::SetBalloonTooltipText ( const char *  balloonTooltipText)

Sets the BalloonTooltipText
Created in NX12.0.0.



License requirements : None

Parameters
balloonTooltipTextballoon tooltip text
void NXOpen::BlockStyler::SelectFacetRegion::SetBitmap ( const NXString bitmapString)

Sets the Bitmap
Created in NX12.0.0.



License requirements : None

Parameters
bitmapStringbitmap string
void NXOpen::BlockStyler::SelectFacetRegion::SetBitmap ( const char *  bitmapString)

Sets the Bitmap
Created in NX12.0.0.



License requirements : None

Parameters
bitmapStringbitmap string
void NXOpen::BlockStyler::SelectFacetRegion::SetCue ( const NXString cue)

Sets the Cue
Created in NX12.0.0.



License requirements : None

Parameters
cuecue
void NXOpen::BlockStyler::SelectFacetRegion::SetCue ( const char *  cue)

Sets the Cue
Created in NX12.0.0.



License requirements : None

Parameters
cuecue
void NXOpen::BlockStyler::SelectFacetRegion::SetEnabledFacetCollectionRules ( int  rulesEnabled)

Sets the FacetCollectionRules.

These are the selection intent rules enabled for the facet selection region block

It returns the following bit values,

  1. 0x1 if only Single Facet rule is enabled,
  2. 0x2 if only Face Facets rule is enabled,
  3. 0x3 if only Flood Fill rule is enabled,
  4. 0x4 if only Color Region rule is enabled


Created in NX12.0.0.

License requirements : None

Parameters
rulesEnabledbit value specifying enabled facet selection rules
void NXOpen::BlockStyler::SelectFacetRegion::SetFacetCollector ( NXOpen::FacetCollector facetCollector)

Sets the OwningFacetCollector.

The owning facet collector is an object of class FacetCollector that holds collected facets of the block


Created in NX12.0.0.

License requirements : None

Parameters
facetCollectorthe facet collector object holding collection of the block
void NXOpen::BlockStyler::SelectFacetRegion::SetLabelString ( const NXString labelString)

Sets the LabelString
Created in NX12.0.0.



License requirements : None

Parameters
labelStringlabelstring
void NXOpen::BlockStyler::SelectFacetRegion::SetLabelString ( const char *  labelString)

Sets the LabelString
Created in NX12.0.0.



License requirements : None

Parameters
labelStringlabelstring
void NXOpen::BlockStyler::SelectFacetRegion::SetSelectedFacetCollectionRule ( int  selectedRule)

Sets the active facet collection rule
Created in NX12.0.0.



License requirements : None

Parameters
selectedRulebit value specifying selected facet selection rule
void NXOpen::BlockStyler::SelectFacetRegion::SetSelectedObjects ( const std::vector< NXOpen::TaggedObject * > &  objectVector)

Sets the SelectedFacetRegions
Created in NX12.0.0.



License requirements : None

Parameters
objectVectorValue to set for the property
void NXOpen::BlockStyler::SelectFacetRegion::SetStepStatusAsString ( const NXString enumString)

Sets the StepStatus as string
Created in NX12.0.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::SelectFacetRegion::SetStepStatusAsString ( const char *  enumString)

Sets the StepStatus as string
Created in NX12.0.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::SelectFacetRegion::SetSupportedFacetTypes ( int  typesEnabled)

Sets the SupportedFacetTypes.

These are type of facets enabled in filters for select facet region block

It returns following bits,

  1. 0x1 if only convergent facets are enabled,
  2. 0x2 if only NX facets are enabled,
  3. 0x3 if both convergent as well as NX facets are enabled.


Created in NX12.0.0.

License requirements : None

Parameters
typesEnabledbit value specifying the desired types of facets to enable in filter
void NXOpen::BlockStyler::SelectFacetRegion::SetToolTip ( const NXString toolTip)

Sets the ToolTip
Created in NX12.0.0.



License requirements : None

Parameters
toolTiptooltip
void NXOpen::BlockStyler::SelectFacetRegion::SetToolTip ( const char *  toolTip)

Sets the ToolTip
Created in NX12.0.0.



License requirements : None

Parameters
toolTiptooltip
NXString NXOpen::BlockStyler::SelectFacetRegion::StepStatusAsString ( )

Returns the StepStatus as string
Created in NX12.0.0.



License requirements : None

int NXOpen::BlockStyler::SelectFacetRegion::SupportedFacetTypes ( )

Returns the SupportedFacetTypes.

These are type of facets enabled in filters for select facet region block

It returns following bits,

  1. 0x1 if only convergent facets are enabled,
  2. 0x2 if only NX facets are enabled,
  3. 0x3 if both convergent as well as NX facets are enabled.


Created in NX12.0.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectFacetRegion::ToolTip ( )

Returns the ToolTip
Created in NX12.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.