NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.ColorDefinition Class Reference

Represents a NXOpen.ColorDefinition , which is a representation of one color on an NX color palette. More...

Inheritance diagram for NXOpen.ColorDefinition:

Public Member Functions

unsafe NXOpen.ColorDefinitionRgb GetColorValues ()
 Gets the color values. More...
 
unsafe void SetColorValues (NXOpen.ColorDefinitionRgb colorVals)
 Sets the color values. More...
 

Properties

unsafe int ColorIndex [get, set]
 Returns or sets the color index. More...
 
unsafe string ColorName [get, set]
 Returns or sets the color name. More...
 
unsafe int FavoriteIndex [get, set]
 Returns or sets the favorite index. More...
 

Detailed Description

Represents a NXOpen.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

unsafe NXOpen.ColorDefinitionRgb NXOpen.ColorDefinition.GetColorValues ( )

Gets 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.

Returns
unsafe void NXOpen.ColorDefinition.SetColorValues ( 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

Property Documentation

unsafe int NXOpen.ColorDefinition.ColorIndex
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.ColorDefinition.ColorName
getset

Returns or sets the color name.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.ColorDefinition.FavoriteIndex
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.


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