All Frameworks  Class Hierarchy  This Framework  Next  Indexes

Visualization Interface CATColorManager

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---CATColorManager
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATColorManager

Class to manage color definition, modification and application.
Role: This static object allows to define, to modify and to apply color in applications.
All applicative color chooser plug-ins should use this class to transmit the results of their interactions.


Method Index


o CATDeclareCBEvent(CURRENT_COLOR_CHANGED)
Event sent when the current defined color is changed.
o CATDeclareCBEvent(NEW_COLOR_CHANGED)
Event sent when the new color is changed.
o GetColorManager()
Returns the CATColorManager pointer.
o GetCurrentColorRGB(float*,float*,float*)
Returns the current defined color.
o GetNewColorRGB(float*,float*,float*)
Returns the new defined color.
o SetCurrentColorRGB(float,float,float)
Sets the current defined color.
o SetNewColorRGB(float,float,float)
Sets the new defined color.

Methods


o CATDeclareCBEvent
public CATDeclareCBEvent(CURRENT_COLOR_CHANGED )
Event sent when the current defined color is changed.
Role:
this event is sent by the CATColorManager.
Sample of callback:
  ::AddCallback(this,
                CATColorManager::GetColorManager(),
	              CATColorManager::CURRENT_COLOR_CHANGED(),
	              (CATSubscriberMethod)&MyClass::MyCBMethod,
	              NULL);
 
o CATDeclareCBEvent
public CATDeclareCBEvent(NEW_COLOR_CHANGED )
Event sent when the new color is changed.
Role:
this event is sent by the CATColorManager.
Sample of callback:
  ::AddCallback(this,
                CATColorManager::GetColorManager(),
	              CATColorManager::NEW_COLOR_CHANGED(),
	              (CATSubscriberMethod)&MyClass::MyCBMethod,
	              NULL);
 
o GetColorManager
public static CATColorManager * GetColorManager()
Returns the CATColorManager pointer.
o GetCurrentColorRGB
public virtual HRESULT GetCurrentColorRGB(float* oR,
float* oG,
float* oB) = 0
Returns the current defined color. The legal value for R, G, B color components is in [0, 1].
o GetNewColorRGB
public virtual HRESULT GetNewColorRGB(float* oR,
float* oG,
float* oB) = 0
Returns the new defined color. The legal value for R, G, B color components is in [0, 1].
o SetCurrentColorRGB
public virtual HRESULT SetCurrentColorRGB( const float iR,
const float iG,
const float iB) = 0
Sets the current defined color. The legal value for R, G, B color components is in [0, 1].
o SetNewColorRGB
public virtual HRESULT SetNewColorRGB( const float iR,
const float iG,
const float iB) = 0
Sets the new defined color. The legal value for R, G, B color components is in [0, 1].

This object is included in the file: CATColorManager.h
If needed, your Imakefile.mk should include the module: CATVisualization

Copyright © 2003, Dassault Systèmes. All rights reserved.