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

Represents a NXOpen::Features::ColorFeatureBuilder Represents a color feature builder. More...

Inheritance diagram for NXOpen::Features::ColorFeatureBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OperationType { OperationTypeSpecifyColor, OperationTypeNoColor }
 specify color or remove color type More...
 

Public Member Functions

NXOpen::NXColorColor ()
 Returns the color
Created in NX8.5.0. More...
 
NXOpen::Features::SelectFeatureListSelectFeature ()
 Returns the features to color
Created in NX8.5.0. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color
Created in NX8.5.0. More...
 
void SetSpecifyColor (NXOpen::Features::ColorFeatureBuilder::OperationType specifyColor)
 Sets the specified color option. More...
 
void SetStoreColor (bool hasStoreColor)
 Sets the save color property to feature
Created in NX8.5.0. More...
 
NXOpen::Features::ColorFeatureBuilder::OperationType SpecifyColor ()
 Returns the specified color option. More...
 
bool StoreColor ()
 Returns the save color property to feature
Created in NX8.5.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 NXOpen::Features::ColorFeatureBuilder Represents a color feature builder.

The color feature does not create a feature, but assists user to assign color to selected features.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateColorFeatureBuilder
Default values.

Property Value

SpecifyColor

SpecifyColor

StoreColor

1


Created in NX8.5.0.

Member Enumeration Documentation

specify color or remove color type

Enumerator
OperationTypeSpecifyColor 

assign color to feature

OperationTypeNoColor 

remove color from feature

Member Function Documentation

NXOpen::NXColor* NXOpen::Features::ColorFeatureBuilder::Color ( )

Returns the color
Created in NX8.5.0.



License requirements : None

NXOpen::Features::SelectFeatureList* NXOpen::Features::ColorFeatureBuilder::SelectFeature ( )

Returns the features to color
Created in NX8.5.0.



License requirements : None

void NXOpen::Features::ColorFeatureBuilder::SetColor ( NXOpen::NXColor color)

Sets the color
Created in NX8.5.0.



License requirements : None

Parameters
colorcolor
void NXOpen::Features::ColorFeatureBuilder::SetSpecifyColor ( NXOpen::Features::ColorFeatureBuilder::OperationType  specifyColor)

Sets the specified color option.

If the option is NXOpen::Features::ColorFeatureBuilder::OperationTypeSpecifyColor , assign valid color to feature. If the returned value is NXOpen::Features::ColorFeatureBuilder::OperationTypeNoColor , remove color from feature
Created in NX8.5.0.

License requirements : None

Parameters
specifyColorspecifycolor
void NXOpen::Features::ColorFeatureBuilder::SetStoreColor ( bool  hasStoreColor)

Sets the save color property to feature
Created in NX8.5.0.



License requirements : None

Parameters
hasStoreColorhasstorecolor
NXOpen::Features::ColorFeatureBuilder::OperationType NXOpen::Features::ColorFeatureBuilder::SpecifyColor ( )

Returns the specified color option.

If the option is NXOpen::Features::ColorFeatureBuilder::OperationTypeSpecifyColor , assign valid color to feature. If the returned value is NXOpen::Features::ColorFeatureBuilder::OperationTypeNoColor , remove color from feature
Created in NX8.5.0.

License requirements : None

bool NXOpen::Features::ColorFeatureBuilder::StoreColor ( )

Returns the save color property to feature
Created in NX8.5.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.