Click or drag to resize
SoWinColorEditor Class

Component that lets you edit a color interactively.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.WinSoWinComponent
      OIV.Inventor.WinSoWinColorEditor

Namespace: OIV.Inventor.Win
Assembly: OIV.Inventor.Win (in OIV.Inventor.Win.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoWinColorEditor : SoWinComponent

The SoWinColorEditor type exposes the following members.

Constructors
  NameDescription
Public methodSoWinColorEditor
Calls SoWinColorEditor((System.Windows.Forms.Control ^)nullptr, (System.String ^)nullptr, true).
Public methodSoWinColorEditor(Control)
Calls SoWinColorEditor(parent, (System.String ^)nullptr, true).
Public methodSoWinColorEditor(Control, String)
Calls SoWinColorEditor(parent, name, true).
Public methodSoWinColorEditor(Control, String, Boolean)

Constructor.

Top
Methods
  NameDescription
Public methodAttach(SoSFColor, SoBase)

Attaches the editor to a color node and edits the specified color.

Public methodAttach(SoMFColor, Int32, SoBase)

Attaches the editor to a color node and edits the specified color.

Public methodAttach(SoMFUInt32, Int32, SoBase)

Handles attaching to an "orderedRGBA" field (e.g. OIV.Inventor.Nodes.SoVertexProperty)

Public methodDetach

Detaches the editor from a color node.

Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetClassName

Returns the class name.

(Inherited from SoWinComponent.)
Public methodGetColor

Gets the current color value.

Public methodGetCurrentSliders

Gets which slider(s) should be displayed.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetIconTitle

Included for portability only.

(Inherited from SoWinComponent.)
Public methodGetSize

Convenience routine on the window handle.

(Inherited from SoWinComponent.)
Public methodGetTitle

Gets window title.

(Inherited from SoWinComponent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateFrequency

Gets the update frequency.

Public methodGetWidgetName

Returns the window handle name.

(Inherited from SoWinComponent.)
Public methodHide

This hides the component.

(Inherited from SoWinComponent.)
Public methodIsAttached

Returns true if the editor is attached.

Public methodIsFullScreen

Queries if the viewer is in fullscreen mode.

(Inherited from SoWinComponent.)
Public methodIsFullScreenEnable

Queries if it is possible to put the viewer in fullscreen mode.

(Inherited from SoWinComponent.)
Public methodIsTopLevelShell

Returns true if this component is a top level shell component (has its own window).

(Inherited from SoWinComponent.)
Public methodIsVisible

Returns true if this component is mapped onto the screen.

(Inherited from SoWinComponent.)
Public methodIsWYSIWYG

Gets the WYSIWYG mode.

Public methodSetColor

Sets a new color value.

Public methodSetCurrentSliders

Sets which slider(s) should be displayed.

Public methodSetFullScreen

Switches the viewer into (or out of) fullscreen mode.

(Inherited from SoWinComponent.)
Public methodSetFullScreenEnable

Enables/disables fullscreen mode.

(Inherited from SoWinComponent.)
Public methodSetIconTitle

Included for portability only.

(Inherited from SoWinComponent.)
Public methodSetSize

Convenience routine on the window handle.

(Inherited from SoWinComponent.)
Public methodSetTitle

Sets window title.

(Inherited from SoWinComponent.)
Public methodSetUpdateFrequency

Sets the update frequency.

Public methodSetWYSIWYG

Sets the WYSIWYG (what-you-see-is-what-you-get) mode on/off for the colored backgrounds of the sliders.

Public methodShow

This shows the component.

(Inherited from SoWinComponent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyAlwaysOnTop
Public propertyHandle
Implements Handle.
(Inherited from SoWinComponent.)
Public propertyWindowCloseCallback

Sets the delegate to invoke when the user closes this component (double click in the upper left corner) - by default Hide() is called on this component, unless a delegate is specified.

(Inherited from SoWinComponent.)
Top
Events
  NameDescription
Public eventColorChanged
Top
Remarks

The OIV.Inventor.Win.SoWinColorEditor class lets you interactively edit colors using color sliders and a color wheel. You can either use it directly to edit a color field in the database by using the OIV.Inventor.Win.SoWinColorEditor.Attach(OIV.Inventor.Fields.SoSFColor, OIV.Inventor.Misc.SoBase)/detach() routines, or use it by registering a delegateroutine which will get called whenever the color changes (passing an OIV.Inventor.SbColor to that routine).

The editor can currently be attached to only one color at a time. Attaching two different colors will automatically detach the first one before attaching the second.

See Also