Common interface for color objects in the ACF color management system. More...

#include <IColorObject.h>

Inheritance diagram for icmm::IColorObject:

Public Member Functions
virtual icmm::CVarColor	GetColor () const =0
	Gets the generic color value representation.

virtual ConstColorModelPtr	GetColorModel () const =0
	Gets the associated color model.

virtual std::unique_ptr< IColorObject >	CloneIntoUniquePtr () const =0
	Creates an independent copy of the color object.

Public Member Functions inherited from iser::IObject
virtual QByteArray	GetFactoryId () const

Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.

virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Common interface for color objects in the ACF color management system.

Purpose

IColorObject represents a color value along with its associated color model. It combines a generic color representation (CVarColor) with type information and model metadata. This interface allows polymorphic handling of colors regardless of their specific color space (RGB, CMYK, Lab, etc.).

Usage Examples

// Example 1: Working with color objects
void ProcessColorObject(const icmm::IColorObject* colorObj)
{
       // Get the generic color value
       icmm::CVarColor color = colorObj->GetColor();
       
       // Get the color model
       icmm::ConstColorModelPtr model = colorObj->GetColorModel();
       
       // Check what type of color this is
       if (model->GetModelType() == icmm::IColorModel::MT_RGB) {
              qDebug() << "Processing RGB color";
              // Access RGB components
              double red = color.GetElement(0);
              double green = color.GetElement(1);
              double blue = color.GetElement(2);
       }
}
 
// Example 2: Cloning color objects
void DuplicateColor(const icmm::IColorObject* original)
{
       // Create independent copy
       std::unique_ptr<IColorObject> copy = original->CloneIntoUniquePtr();
       
       // Modify copy without affecting original
       icmm::CVarColor color = copy->GetColor();
       color.SetElement(0, 0.5);
       // ... use modified copy
}
 
// Example 3: Converting colors through polymorphism
std::unique_ptr<icmm::IColorObject> ConvertColor(
       const icmm::IColorObject* source,
       icmm::ConstColorModelPtr targetModel)
{
       // Get source color and model
       icmm::CVarColor sourceColor = source->GetColor();
       icmm::ConstColorModelPtr sourceModel = source->GetColorModel();
       
       // Create transformation
       const icmm::IColorTransformation* transform = 
              sourceModel->CreateColorTranformation(*targetModel);
       
       if (transform) {
              // Transform color
              icmm::CVarColor resultColor;
              if (transform->Calculate(sourceColor, resultColor)) {
                     // Create new color object in target model
                     // (Implementation depends on specific color class)
              }
              delete transform;
       }
       
       return nullptr;  // Return converted color object
}
 
// Example 4: Polymorphic color storage
void StoreColors(const QList<IColorObject*>& colors)
{
       // Can store colors of any type
       for (const IColorObject* color : colors) {
              icmm::ConstColorModelPtr model = color->GetColorModel();
              
              // Serialize or process based on model type
              switch (model->GetModelType()) {
              case icmm::IColorModel::MT_RGB:
                     SaveRgbColor(color);
                     break;
              case icmm::IColorModel::MT_CMYK:
                     SaveCmykColor(color);
                     break;
              default:
                     SaveGenericColor(color);
                     break;
              }
       }
}

Polymorphic Design

IColorObject enables writing color-agnostic code that works with any color model. This is essential for:

Generic color processing pipelines
Color management systems
User interfaces for color selection
Color format conversion tools
Serialization frameworks

See also: icmm::IColorModel, icmm::CVarColor, icmm::IRgbColor, icmm::ICieLabColor, iser::IObject

Definition at line 120 of file IColorObject.h.

Member Function Documentation

◆ CloneIntoUniquePtr()

virtual std::unique_ptr< IColorObject > icmm::IColorObject::CloneIntoUniquePtr ( ) const

pure virtual

Creates an independent copy of the color object.

Clones this color object, creating a new instance with the same color value and model. The clone is independent - modifications to it won't affect the original.

Returns: Unique pointer to the cloned color object

Note: The returned unique_ptr manages the lifetime automatically.

std::unique_ptr<IColorObject> copy = original->CloneIntoUniquePtr();

// Modify copy independently

See also: GetColor()

Implemented in icmm::CCieLabColor, icmm::CRgbColor, and icmm::CSpectralColor.

◆ GetColor()

virtual icmm::CVarColor icmm::IColorObject::GetColor ( ) const

pure virtual

Gets the generic color value representation.

Returns the color as a CVarColor, which is a variable-size vector containing the component values in the associated color model.

Returns: CVarColor containing the color component values

icmm::CVarColor color = colorObj->GetColor();
int components = color.GetElementsCount();
for (int i = 0; i < components; ++i) {
       double value = color.GetElement(i);
}

See also: CVarColor, GetColorModel()

Implemented in icmm::CCieLabColor, icmm::CRgbColor, and icmm::CSpectralColor.

◆ GetColorModel()

virtual ConstColorModelPtr icmm::IColorObject::GetColorModel ( ) const

pure virtual

Gets the associated color model.

Returns the color model that defines the interpretation of the color component values. This specifies the color space and provides metadata about the components.

Returns: Shared pointer to the const color model

Note: The returned pointer is valid for the lifetime of the color object.

See also: IColorModel, GetColor()

Implemented in icmm::CCieLabColor, icmm::CRgbColor, and icmm::CSpectralColor.

The documentation for this class was generated from the following file:

Acf/Include/icmm/IColorObject.h

Public Member Functions

Additional Inherited Members

Detailed Description

Purpose

Usage Examples

Polymorphic Design

Member Function Documentation

◆ CloneIntoUniquePtr()

◆ GetColor()

◆ GetColorModel()