Represents a Select Object block
Created in NX8.5.0. More...

Inheritance diagram for NXOpen::BlockStyler::SelectObject:

Public Types
enum	FilterType { FilterTypeFeatures = 1, FilterTypeFaces, FilterTypeEdges = 4, FilterTypeCurvesAndEdges = 8, FilterTypeComponents = 16, FilterTypeSolidBodies = 32, FilterTypeSheetBodies = 64 }
	Indicates the general filter type for selection. More...

Public Member Functions
void	AddFilter (int filterTypes)
	Adds the filters for select object block Created in NX8.5.0.

void	AddFilter (int type, int subType, int solidBodyType)
	Adds the filter for select object block using type, subtype and solidBodyType Created in NX8.5.0.

bool	AutomaticProgression ()
	Returns the AutomaticProgression Created in NX8.5.0.

NXString	BalloonTooltipImage ()
	Returns the BalloonTooltipImage Created in NX8.5.0.

NXString	BalloonTooltipLayoutAsString ()
	Returns the BalloonTooltipLayout as string Created in NX8.5.0.

NXString	BalloonTooltipText ()
	Returns the BalloonTooltipText Created in NX8.5.0.

NXString	Bitmap ()
	Returns the Bitmap Created in NX8.5.0.

bool	BlendVirtualCurveOverlay ()
	Returns the BlendVirtualCurveOverlay.

bool	CreateInterpartLink ()
	Returns the CreateInterpartLink Created in NX8.5.0.

NXString	Cue ()
	Returns the Cue Created in NX8.5.0.

std::vector< NXString >	GetBalloonTooltipLayoutMembers ()
	Gets the BalloonTooltipLayout members.

std::vector< NXString >	GetInterpartSelectionMembers ()
	Gets the InterpartSelection members.

std::vector < NXOpen::TaggedObject * >	GetLastDeselectedObjects ()
	Gets the LastDeselectedObjects.

std::vector < NXOpen::TaggedObject * >	GetLastSelectedObjects ()
	Gets the LastSelectedObjects.

std::vector< NXString >	GetMaximumScopeMembers ()
	Gets the MaximumScope members.

std::vector < NXOpen::TaggedObject * >	GetSelectedObjects ()
	Gets the SelectedObjects.

std::vector< NXString >	GetSelectModeMembers ()
	Gets the SelectMode members.

std::vector< NXString >	GetStepStatusMembers ()
	Gets the StepStatus members.

NXString	InterpartSelectionAsString ()
	Returns the InterpartSelection as string Created in NX8.5.0.

NXString	LabelString ()
	Returns the LabelString Created in NX8.5.0.

NXString	MaximumScopeAsString ()
	Returns the MaximumScope as string Created in NX8.5.0.

NXOpen::Point3d	PickPoint ()
	Returns the PickPoint Created in NX8.5.0.

bool	PointOverlay ()
	Returns the PointOverlay.

void	ResetFilter ()
	Resets the filter for select object block Created in NX8.5.0.

NXString	SelectModeAsString ()
	Returns the SelectMode as string Created in NX8.5.0.

void	SetAutomaticProgression (bool automaticProgression)
	Sets the AutomaticProgression Created in NX8.5.0.

void	SetBalloonTooltipImage (const NXString &imageString)
	Sets the BalloonTooltipImage Created in NX8.5.0.

void	SetBalloonTooltipImage (const char *imageString)
	Sets the BalloonTooltipImage Created in NX8.5.0.

void	SetBalloonTooltipLayoutAsString (const NXString &enumString)
	Sets the BalloonTooltipLayout as string Created in NX8.5.0.

void	SetBalloonTooltipLayoutAsString (const char *enumString)
	Sets the BalloonTooltipLayout as string Created in NX8.5.0.

void	SetBalloonTooltipText (const NXString &balloonTooltipText)
	Sets the BalloonTooltipText Created in NX8.5.0.

void	SetBalloonTooltipText (const char *balloonTooltipText)
	Sets the BalloonTooltipText Created in NX8.5.0.

void	SetBitmap (const NXString &bitmapString)
	Sets the Bitmap Created in NX8.5.0.

void	SetBitmap (const char *bitmapString)
	Sets the Bitmap Created in NX8.5.0.

void	SetBlendVirtualCurveOverlay (bool blendCurve)
	Sets the BlendVirtualCurveOverlay.

void	SetCreateInterpartLink (bool createLink)
	Sets the CreateInterpartLink Created in NX8.5.0.

void	SetCue (const NXString &cue)
	Sets the Cue Created in NX8.5.0.

void	SetCue (const char *cue)
	Sets the Cue Created in NX8.5.0.

void	SetInterpartSelectionAsString (const NXString &enumString)
	Sets the InterpartSelection as string Created in NX8.5.0.

void	SetInterpartSelectionAsString (const char *enumString)
	Sets the InterpartSelection as string Created in NX8.5.0.

void	SetLabelString (const NXString &labelString)
	Sets the LabelString Created in NX8.5.0.

void	SetLabelString (const char *labelString)
	Sets the LabelString Created in NX8.5.0.

void	SetMaximumScopeAsString (const NXString &enumString)
	Sets the MaximumScope as string Created in NX8.5.0.

void	SetMaximumScopeAsString (const char *enumString)
	Sets the MaximumScope as string Created in NX8.5.0.

void	SetPointOverlay (bool pointOverlay)
	Sets the PointOverlay.

void	SetSelectedObjects (const std::vector< NXOpen::TaggedObject * > &objectVector)
	Sets the SelectedObjects Created in NX8.5.0.

void	SetSelectionFilter (NXOpen::Selection::SelectionAction maskAction, const std::vector< NXOpen::Selection::MaskTriple > &maskTriples)
	Sets the SelectionFilter Created in NX8.5.0.

void	SetSelectModeAsString (const NXString &enumString)
	Sets the SelectMode as string Created in NX8.5.0.

void	SetSelectModeAsString (const char *enumString)
	Sets the SelectMode as string Created in NX8.5.0.

void	SetSmartUpdateOptionAsString (const NXString &enumString)
	Sets the update option for points created by the point overlay.

void	SetSmartUpdateOptionAsString (const char *enumString)
	Sets the update option for points created by the point overlay.

void	SetSnapPointTypesEnabled (int typesEnabled)
	Sets the SnapPointTypesEnabled Created in NX8.5.0.

void	SetSnapPointTypesOnByDefault (int typesByDefault)
	Sets the SnapPointTypesOnByDefault Created in NX8.5.0.

void	SetStepStatusAsString (const NXString &enumString)
	Sets the StepStatus as string Created in NX8.5.0.

void	SetStepStatusAsString (const char *enumString)
	Sets the StepStatus as string Created in NX8.5.0.

void	SetToolTip (const NXString &toolTip)
	Sets the ToolTip Created in NX8.5.0.

void	SetToolTip (const char *toolTip)
	Sets the ToolTip Created in NX8.5.0.

NXString	SmartUpdateOptionAsString ()
	Returns the update option for points created by the point overlay.

int	SnapPointTypesEnabled ()
	Returns the SnapPointTypesEnabled Created in NX8.5.0.

int	SnapPointTypesOnByDefault ()
	Returns the SnapPointTypesOnByDefault Created in NX8.5.0.

NXString	StepStatusAsString ()
	Returns the StepStatus as string Created in NX8.5.0.

NXString	ToolTip ()
	Returns the ToolTip Created in NX8.5.0.

Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool	Enable ()
	Returns the Enable.

bool	Expanded ()
	Returns the Expanded Created in NX8.5.0.

void	Focus ()
	Focuses on the block.

NXOpen::BlockStyler::PropertyList *	GetProperties ()
	Returns the properties of the block.

bool	Group ()
	Returns the Group Created in NX8.5.0.

NXString	Label ()
	Returns the Label Created in NX8.5.0.

NXString	Name ()
	Returns the name of the block or BlockID Created in NX6.0.0.

void	SetEnable (bool enable)
	Sets the Enable.

void	SetExpanded (bool expanded)
	Sets the Expanded Created in NX8.5.0.

void	SetGroup (bool group)
	Sets the Group Created in NX8.5.0.

void	SetLabel (const NXString &label)
	Sets the Label Created in NX8.5.0.

void	SetLabel (const char *label)
	Sets the Label Created in NX8.5.0.

void	SetShow (bool show)
	Sets the Visibility of block.

bool	Show ()
	Returns the Visibility of block.

NXString	Type ()
	Returns the type of block Created in NX6.0.0.

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 Select Object block
Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::BlockStyler::SelectObject::FilterType

Indicates the general filter type for selection.

Enumerator:

FilterTypeFaces

Filter to select all face types.

Member Function Documentation

void NXOpen::BlockStyler::SelectObject::AddFilter ( int filterTypes )

Adds the filters for select object block
Created in NX8.5.0.

License requirements : None

Parameters

filterTypes Values from SelectObject::FilterType for specifying filters

void NXOpen::BlockStyler::SelectObject::AddFilter	(	int	type,
		int	subType,
		int	solidBodyType
	)

Adds the filter for select object block using type, subtype and solidBodyType
Created in NX8.5.0.

License requirements : None

Parameters

type	Object type. This can be one of the object types that are listed in uf_object_types.h. For example, for point, use UF_point_type in C++ and NXOpen.UF.UFConstants.UF_point_type in .NET.
subType	Object subtype. This can either be 0 (UF_all_subtype) for any subtype, or a subtype of the selected type. The subtypes are listed in uf_object_types.h.
solidBodyType	Solid body subtype. This is only meaningful when the type is UF_solid_type. In that case, this should be set to one of the solid type constants listed in uf_ui_types.h under "Constants for selection solid_type". For example, to select any face, use UF_UI_SEL_FEATURE_ANY_FACE in C++ and NXOpen.UF.UFConstants.UF_UI_SEL_FEATURE_ANY_FACE in .NET

bool NXOpen::BlockStyler::SelectObject::AutomaticProgression ( )

Returns the AutomaticProgression
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::BalloonTooltipImage ( )

Returns the BalloonTooltipImage
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::BalloonTooltipLayoutAsString ( )

Returns the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::BalloonTooltipText ( )

Returns the BalloonTooltipText
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::Bitmap ( )

Returns the Bitmap
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SelectObject::BlendVirtualCurveOverlay ( )

Returns the BlendVirtualCurveOverlay.

If true, virtual curve is displayed during preselection.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SelectObject::CreateInterpartLink ( )

Returns the CreateInterpartLink
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::Cue ( )

Returns the Cue
Created in NX8.5.0.

License requirements : None

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

Gets the BalloonTooltipLayout members.

Returns: Value to get from the property.
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SelectObject::GetInterpartSelectionMembers ( )

Gets the InterpartSelection members.

Returns: Value to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXOpen::TaggedObject *> NXOpen::BlockStyler::SelectObject::GetLastDeselectedObjects ( )

Gets the LastDeselectedObjects.

Returns: Value to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXOpen::TaggedObject *> NXOpen::BlockStyler::SelectObject::GetLastSelectedObjects ( )

Gets the LastSelectedObjects.

Returns: Value to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SelectObject::GetMaximumScopeMembers ( )

Gets the MaximumScope members.

Returns: Value to get from the property.
Created in NX8.5.0.

License requirements : None

std::vector<NXOpen::TaggedObject *> NXOpen::BlockStyler::SelectObject::GetSelectedObjects ( )

Gets the SelectedObjects.

Returns: Value to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SelectObject::GetSelectModeMembers ( )

Gets the SelectMode members.

Returns: Value to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SelectObject::GetStepStatusMembers ( )

Gets the StepStatus members.

Returns: Value to get from the property
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::InterpartSelectionAsString ( )

Returns the InterpartSelection as string
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::LabelString ( )

Returns the LabelString
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::MaximumScopeAsString ( )

Returns the MaximumScope as string
Created in NX8.5.0.

License requirements : None

NXOpen::Point3d NXOpen::BlockStyler::SelectObject::PickPoint ( )

Returns the PickPoint
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SelectObject::PointOverlay ( )

Returns the PointOverlay.

If true,on the fly point creation is allowed.
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::SelectObject::ResetFilter ( )

Resets the filter for select object block
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::SelectModeAsString ( )

Returns the SelectMode as string
Created in NX8.5.0.

License requirements : None

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

Sets the AutomaticProgression
Created in NX8.5.0.

License requirements : None

Parameters

automaticProgression automaticprogression

void NXOpen::BlockStyler::SelectObject::SetBalloonTooltipImage ( const NXString & imageString )

Sets the BalloonTooltipImage
Created in NX8.5.0.

License requirements : None

Parameters

imageString image string

void NXOpen::BlockStyler::SelectObject::SetBalloonTooltipImage ( const char * imageString )

Sets the BalloonTooltipImage
Created in NX8.5.0.

License requirements : None

Parameters

imageString image string

void NXOpen::BlockStyler::SelectObject::SetBalloonTooltipLayoutAsString ( const NXString & enumString )

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetBalloonTooltipLayoutAsString ( const char * enumString )

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetBalloonTooltipText ( const NXString & balloonTooltipText )

Sets the BalloonTooltipText
Created in NX8.5.0.

License requirements : None

Parameters

balloonTooltipText balloon tooltip text

void NXOpen::BlockStyler::SelectObject::SetBalloonTooltipText ( const char * balloonTooltipText )

Sets the BalloonTooltipText
Created in NX8.5.0.

License requirements : None

Parameters

balloonTooltipText balloon tooltip text

void NXOpen::BlockStyler::SelectObject::SetBitmap ( const NXString & bitmapString )

Sets the Bitmap
Created in NX8.5.0.

License requirements : None

Parameters

bitmapString bitmap string

void NXOpen::BlockStyler::SelectObject::SetBitmap ( const char * bitmapString )

Sets the Bitmap
Created in NX8.5.0.

License requirements : None

Parameters

bitmapString bitmap string

void NXOpen::BlockStyler::SelectObject::SetBlendVirtualCurveOverlay ( bool blendCurve )

Sets the BlendVirtualCurveOverlay.

If true, virtual curve is displayed during preselection.
Created in NX8.5.0.

License requirements : None

Parameters

blendCurve blendcurve

void NXOpen::BlockStyler::SelectObject::SetCreateInterpartLink ( bool createLink )

Sets the CreateInterpartLink
Created in NX8.5.0.

License requirements : None

Parameters

createLink createlink

void NXOpen::BlockStyler::SelectObject::SetCue ( const NXString & cue )

Sets the Cue
Created in NX8.5.0.

License requirements : None

Parameters

cue cue

void NXOpen::BlockStyler::SelectObject::SetCue ( const char * cue )

Sets the Cue
Created in NX8.5.0.

License requirements : None

Parameters

cue cue

void NXOpen::BlockStyler::SelectObject::SetInterpartSelectionAsString ( const NXString & enumString )

Sets the InterpartSelection as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetInterpartSelectionAsString ( const char * enumString )

Sets the InterpartSelection as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetLabelString ( const NXString & labelString )

Sets the LabelString
Created in NX8.5.0.

License requirements : None

Parameters

labelString labelstring

void NXOpen::BlockStyler::SelectObject::SetLabelString ( const char * labelString )

Sets the LabelString
Created in NX8.5.0.

License requirements : None

Parameters

labelString labelstring

void NXOpen::BlockStyler::SelectObject::SetMaximumScopeAsString ( const NXString & enumString )

Sets the MaximumScope as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetMaximumScopeAsString ( const char * enumString )

Sets the MaximumScope as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetPointOverlay ( bool pointOverlay )

Sets the PointOverlay.

If true,on the fly point creation is allowed.
Created in NX8.5.0.

License requirements : None

Parameters

pointOverlay pointoverlay

void NXOpen::BlockStyler::SelectObject::SetSelectedObjects ( const std::vector< NXOpen::TaggedObject * > & objectVector )

Sets the SelectedObjects
Created in NX8.5.0.

License requirements : None

Parameters

objectVector Value to set for the property

void NXOpen::BlockStyler::SelectObject::SetSelectionFilter	(	NXOpen::Selection::SelectionAction	maskAction,
		const std::vector< NXOpen::Selection::MaskTriple > &	maskTriples
	)

Sets the SelectionFilter
Created in NX8.5.0.

License requirements : None

Parameters

maskAction	Mask action
maskTriples	Mask triples

void NXOpen::BlockStyler::SelectObject::SetSelectModeAsString ( const NXString & enumString )

Sets the SelectMode as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetSelectModeAsString ( const char * enumString )

Sets the SelectMode as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetSmartUpdateOptionAsString ( const NXString & enumString )

Sets the update option for points created by the point overlay.

    <br> 
   Acceptable values are:
   <ul>
   <li> <b>Within Modeling</b> The smart object updates within Modeling in time stamp order. For example, if the smart object is referenced by Feature(i), the smart object will update after Feature (i-1) and right before Feature(i).</li>
   <li> <b>After Modeling</b> The smart object updates after Modeling. Use for Drafting dimensions and other objects outside Modeling.</li>
   <li> <b>After Parent Body</b> The smart object will always update after the last feature on the parent body.</li>
   <li> <b>Mixed</b> The smart object will update after the last feature on the parent body when the parent body is in a different part; updates within Modeling in time-stamp order for parents in the same part.</li>
   </ul>
    <br>

Created in NX8.5.1.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetSmartUpdateOptionAsString ( const char * enumString )

Sets the update option for points created by the point overlay.

    <br> 
   Acceptable values are:
   <ul>
   <li> <b>Within Modeling</b> The smart object updates within Modeling in time stamp order. For example, if the smart object is referenced by Feature(i), the smart object will update after Feature (i-1) and right before Feature(i).</li>
   <li> <b>After Modeling</b> The smart object updates after Modeling. Use for Drafting dimensions and other objects outside Modeling.</li>
   <li> <b>After Parent Body</b> The smart object will always update after the last feature on the parent body.</li>
   <li> <b>Mixed</b> The smart object will update after the last feature on the parent body when the parent body is in a different part; updates within Modeling in time-stamp order for parents in the same part.</li>
   </ul>
    <br>

Created in NX8.5.1.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetSnapPointTypesEnabled ( int typesEnabled )

Sets the SnapPointTypesEnabled
Created in NX8.5.0.

License requirements : None

Parameters

typesEnabled typesenabled

void NXOpen::BlockStyler::SelectObject::SetSnapPointTypesOnByDefault ( int typesByDefault )

Sets the SnapPointTypesOnByDefault
Created in NX8.5.0.

License requirements : None

Parameters

typesByDefault typesbydefault

void NXOpen::BlockStyler::SelectObject::SetStepStatusAsString ( const NXString & enumString )

Sets the StepStatus as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetStepStatusAsString ( const char * enumString )

Sets the StepStatus as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SelectObject::SetToolTip ( const NXString & toolTip )

Sets the ToolTip
Created in NX8.5.0.

License requirements : None

Parameters

toolTip tooltip

void NXOpen::BlockStyler::SelectObject::SetToolTip ( const char * toolTip )

Sets the ToolTip
Created in NX8.5.0.

License requirements : None

Parameters

toolTip tooltip

NXString NXOpen::BlockStyler::SelectObject::SmartUpdateOptionAsString ( )

Returns the update option for points created by the point overlay.

    <br> 
   Acceptable values are:
   <ul>
   <li> <b>Within Modeling</b> The smart object updates within Modeling in time stamp order. For example, if the smart object is referenced by Feature(i), the smart object will update after Feature (i-1) and right before Feature(i).</li>
   <li> <b>After Modeling</b> The smart object updates after Modeling. Use for Drafting dimensions and other objects outside Modeling.</li>
   <li> <b>After Parent Body</b> The smart object will always update after the last feature on the parent body.</li>
   <li> <b>Mixed</b> The smart object will update after the last feature on the parent body when the parent body is in a different part; updates within Modeling in time-stamp order for parents in the same part.</li>
   </ul>
    <br>

Created in NX8.5.1.

License requirements : None

int NXOpen::BlockStyler::SelectObject::SnapPointTypesEnabled ( )

Returns the SnapPointTypesEnabled
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::SelectObject::SnapPointTypesOnByDefault ( )

Returns the SnapPointTypesOnByDefault
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::StepStatusAsString ( )

Returns the StepStatus as string
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SelectObject::ToolTip ( )

Returns the ToolTip
Created in NX8.5.0.

License requirements : None

The documentation for this class was generated from the following file:

BlockStyler_SelectObject.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation