Represents a ColorDefinition , which is a representation of one color on an NX color palette. More...
Public Member Functions | |
| int | ColorIndex () |
| Returns the color index. | |
| NXString | ColorName () |
| Returns the color name. | |
| int | FavoriteIndex () |
| Returns the favorite index. | |
| NXOpen::ColorDefinitionRgb | GetColorValues () |
| Gets the color values. | |
| void | SetColorIndex (int colorIdx) |
| Sets the color index. | |
| void | SetColorName (const NXString &colorName) |
| Sets the color name. | |
| void | SetColorName (const char *colorName) |
| Sets the color name. | |
| void | SetColorValues (const NXOpen::ColorDefinitionRgb &colorVals) |
| Sets the color values. | |
| void | SetFavoriteIndex (int favoriteIdx) |
| Sets the favorite index. | |
 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 ColorDefinition , which is a representation of one color on an NX color palette.
Each color has an index into the palette, a name, rgb values, and an optional favorite index.
Created in NX5.0.0.
Member Function Documentation
| int NXOpen::ColorDefinition::ColorIndex | ( | ) |
Returns the color index.
This is an number ranging from 0 to 216, each color on the color palette must have a unique index.
Created in NX5.0.0.
License requirements : None
| NXString NXOpen::ColorDefinition::ColorName | ( | ) |
Returns the color name.
Created in NX5.0.0.
License requirements : None
| int NXOpen::ColorDefinition::FavoriteIndex | ( | ) |
Returns the favorite index.
The favorite index is a unique number between 0 and 29 specifing the index into the favorite color array. If the color is not a favorite, it has an index of -1.
Created in NX5.0.0.
License requirements : None
| NXOpen::ColorDefinitionRgb NXOpen::ColorDefinition::GetColorValues | ( | ) |
Gets the color values.
This is an array of 3 doubles containing the RGB values of the color.
- Returns
Created in NX5.0.0.
License requirements : None
| void NXOpen::ColorDefinition::SetColorIndex | ( | int | colorIdx | ) |
Sets the color index.
This is an number ranging from 0 to 216, each color on the color palette must have a unique index.
Created in NX5.0.0.
License requirements : None
- Parameters
-
colorIdx coloridx
| void NXOpen::ColorDefinition::SetColorName | ( | const NXString & | colorName | ) |
Sets the color name.
Created in NX5.0.0.
License requirements : None
- Parameters
-
colorName colorname
| void NXOpen::ColorDefinition::SetColorName | ( | const char * | colorName | ) |
Sets the color name.
Created in NX5.0.0.
License requirements : None
- Parameters
-
colorName colorname
| void NXOpen::ColorDefinition::SetColorValues | ( | const NXOpen::ColorDefinitionRgb & | colorVals | ) |
Sets the color values.
This is an array of 3 doubles containing the RGB values of the color.
Created in NX5.0.0.
License requirements : None
- Parameters
-
colorVals colorvals
| void NXOpen::ColorDefinition::SetFavoriteIndex | ( | int | favoriteIdx | ) |
Sets the favorite index.
The favorite index is a unique number between 0 and 29 specifing the index into the favorite color array. If the color is not a favorite, it has an index of -1.
Created in NX5.0.0.
License requirements : None
- Parameters
-
favoriteIdx favoriteidx
The documentation for this class was generated from the following file:
- ColorDefinition.hxx