NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::Features::CustomFeatureHighlightEvent Class Reference

Represents the event data for highlight callback for custom feature
This class cannot be created

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::Features::CustomFeatureHighlightEvent:
NXOpen::Features::CustomFeatureEvent NXOpen::TaggedObject

Public Member Functions

bool GetHighlightFlag ()
 Gets the highlight flag status of highlight event. More...
 
bool GetHighlightOnlySuppliedObjectsOption ()
 Gets the highlight only supplied objects (objects passed to NXOpen::Features::CustomFeatureHighlightEvent::ObjectsToHighlightUnhighlight ) option of highlight event. More...
 
void ObjectsToHighlightUnhighlight (const std::vector< NXOpen::DisplayableObject * > &objectsToHighlight)
 Highlights or unhighlights the objects passed in objectsToHighlight depending on the highlightFlag status
Created in NX12.0.0. More...
 
void SetHighlightOnlySuppliedObjectsOption (bool highlightOption)
 Sets the highlight only supplied objects (objects passed to NXOpen::Features::CustomFeatureHighlightEvent::ObjectsToHighlightUnhighlight ) option of highlight event
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Features::CustomFeatureEvent
int ErrorCode ()
 Returns the error occured during the event
This API is now deprecated. More...
 
std::vector
< NXOpen::Features::ConstructionFeatureData * > 
GetConstructionFeatures ()
 Get construction features of custom feature. More...
 
NXOpen::Features::CustomFeatureGetCustomFeature ()
 Get the custom feature of the event. More...
 
NXOpen::DisplayableObjectGetNXObject (NXOpen::Features::CustomFeatureEvent::ParasolidId parasolidId)
 Returns the Solid body
Created in NX11.0.0. More...
 
std::vector
< NXOpen::Features::OutputFeatureData * > 
GetOutputFeatures ()
 Get output features of custom feature. More...
 
NXOpen::Features::CustomFeatureEvent::ParasolidId GetParasolidId (NXOpen::DisplayableObject *solidTag)
 Get the Parasolid tag of Solid body
Created in NX11.0.0. More...
 
void SetErrorCode (int errorCode)
 Sets the error occured during the event
This API is now deprecated. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::Features::CustomFeatureEvent
enum  ParasolidId { ParasolidIdDummyMember }
 

Detailed Description

Represents the event data for highlight callback for custom feature
This class cannot be created

Created in NX12.0.0.


Member Function Documentation

bool NXOpen::Features::CustomFeatureHighlightEvent::GetHighlightFlag ( )

Gets the highlight flag status of highlight event.

Returns
Get Highlight Flag, true = Highlight, false = Unhighlight
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
bool NXOpen::Features::CustomFeatureHighlightEvent::GetHighlightOnlySuppliedObjectsOption ( )

Gets the highlight only supplied objects (objects passed to NXOpen::Features::CustomFeatureHighlightEvent::ObjectsToHighlightUnhighlight ) option of highlight event.

Returns
Get Highlight Only Objects Option
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
void NXOpen::Features::CustomFeatureHighlightEvent::ObjectsToHighlightUnhighlight ( const std::vector< NXOpen::DisplayableObject * > &  objectsToHighlight)

Highlights or unhighlights the objects passed in objectsToHighlight depending on the highlightFlag status
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
objectsToHighlightobjectstohighlight
void NXOpen::Features::CustomFeatureHighlightEvent::SetHighlightOnlySuppliedObjectsOption ( bool  highlightOption)

Sets the highlight only supplied objects (objects passed to NXOpen::Features::CustomFeatureHighlightEvent::ObjectsToHighlightUnhighlight ) option of highlight event
Created in NX12.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
highlightOptionSet Highlight Only Objects Option

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