icmm::CSpectralColor Class Reference

#include <CSpectralColor.h>

Inheritance diagram for icmm::CSpectralColor:

Public Member Functions
	CSpectralColor (ColorModelPtr modelPtr)
	CSpectralColor (std::shared_ptr< ISpectralColorSpecification > spec)
bool	SetColor (const icmm::CVarColor &values)
ISpectralColorSpecification::ConstSpectralColorSpecPtr	GetSpecification () const
virtual icmm::CVarColor	GetColor () const override
	Gets the generic color value representation.
virtual ConstColorModelPtr	GetColorModel () const override
	Gets the associated color model.
virtual std::unique_ptr< IColorObject >	CloneIntoUniquePtr () const override
	Creates an independent copy of the color object.
virtual bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.
Public Member Functions inherited from iser::IObject
virtual QByteArray	GetFactoryId () const
Public Member Functions inherited from iser::ISerializable
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

Definition at line 14 of file CSpectralColor.h.

Constructor & Destructor Documentation

CSpectralColor() [1/2]

icmm::CSpectralColor::CSpectralColor

(

ColorModelPtr

modelPtr

)

CSpectralColor() [2/2]

icmm::CSpectralColor::CSpectralColor

(

std::shared_ptr< ISpectralColorSpecification >

spec

)

Member Function Documentation

CloneIntoUniquePtr()

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

overridevirtual

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()

Implements icmm::IColorObject.

GetColor()

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

overridevirtual

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()

Implements icmm::IColorObject.

GetColorModel()

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

overridevirtual

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()

Implements icmm::IColorObject.

GetSpecification()

ISpectralColorSpecification::ConstSpectralColorSpecPtr icmm::CSpectralColor::GetSpecification

(

)

const

Serialize()

virtual bool icmm::CSpectralColor::Serialize ( iser::IArchive &  archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also

iser::IArchive

Implements iser::ISerializable.

SetColor()

bool icmm::CSpectralColor::SetColor

(

const icmm::CVarColor &

values

)

---

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

• Acf/Include/icmm/CSpectralColor.h