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...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. 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...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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 ( )

inline

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 )

inline

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:

• ColorDefinition.cs