Primitive for representation of HSV color value. More...

#include <CHsv.h>

Inheritance diagram for icmm::CHsv:

Collaboration diagram for icmm::CHsv:

Public Types
enum	ComponentIndex { CI_HUE , CI_SATURATION , CI_VALUE , CI_LAST = CI_VALUE }

typedef TComposedColor< 3 >	BaseClass

Public Types inherited from icmm::TComposedColor< 3 >
typedef imath::TVector< Size >	BaseClass

typedef BaseClass::Elements	Elements

Public Types inherited from imath::TVector< Size, Element >
typedef Element	ElementType

typedef std::array< Element, Size >	Elements

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5 }
	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...

Public Member Functions
	CHsv (double h=0.0, double s=0.0, double v=0.0)

	CHsv (const CHsv &color)

	CHsv (const imath::CVarVector &vector)

double	GetHue () const

void	SetHue (double value)

double	GetSaturation () const

void	SetSaturation (double value)

double	GetValue () const

void	SetValue (double value)

bool	Serialize (iser::IArchive &archive)
	Load or store state of this object as a archive stream.

CHsv	operator+ (const CHsv &color) const

CHsv	operator- (const CHsv &color) const

CHsv	operator* (const CHsv &color) const

CHsv	operator/ (const CHsv &color) const

CHsv	operator* (double value) const

CHsv	operator/ (double value) const

CHsv &	operator= (const CHsv &color)

const CHsv &	operator+= (const CHsv &color)

const CHsv &	operator-= (const CHsv &color)

const CHsv &	operator*= (const CHsv &color)

const CHsv &	operator/= (const CHsv &color)

const CHsv &	operator*= (double value)

const CHsv &	operator/= (double value)

Public Member Functions inherited from icmm::TComposedColor< 3 >
	TComposedColor ()

	TComposedColor (const BaseClass &value)

	TComposedColor (const imath::CVarVector &vector)

void	GetRounded (const imath::IDoubleManip &manipulator, TComposedColor< Size > &result)
	Get color after components value rounding with specified precision.

bool	IsRoundedEqual (const TComposedColor< Size > &color, const imath::IDoubleManip &manipulator) const
	Check if two values are equal after rounding.

bool	IsSimilar (const TComposedColor< Size > &color, double tolerance=I_BIG_EPSILON) const
	Allows to compare two colors with tolerance.

bool	IsNormalized () const
	Check if this color value is normalized.

void	Normalize ()
	Make this color to be normalized.

void	GetNormalized (TComposedColor< Size > &result) const
	Get normalized color.

TComposedColor< Size >	operator+ (const TComposedColor< Size > &color) const

TComposedColor< Size >	operator- (const TComposedColor< Size > &color) const

TComposedColor< Size >	operator* (const TComposedColor< Size > &color) const

TComposedColor< Size >	operator* (double value) const

TComposedColor< Size >	operator/ (const TComposedColor< Size > &color) const

TComposedColor< Size >	operator/ (double value) const

const TComposedColor< Size > &	operator= (const TComposedColor< Size > &color)

const TComposedColor< Size > &	operator= (double colorValue)

const TComposedColor< Size > &	operator+= (const TComposedColor< Size > &color)

const TComposedColor< Size > &	operator-= (const TComposedColor< Size > &color)

const TComposedColor< Size > &	operator*= (const TComposedColor< Size > &color)

const TComposedColor< Size > &	operator*= (double value)

const TComposedColor< Size > &	operator/= (const TComposedColor< Size > &color)

const TComposedColor< Size > &	operator/= (double value)

Public Member Functions inherited from imath::TVector< Size, Element >
	TVector ()
	Create an uninitialized point.

	TVector (const TVector< Size, Element > &vector)
	Copy constructor.

	TVector (TVector< Size, Element > &&vector) noexcept
	Move constructor.

const Element &	GetElement (int i) const
	Get element at specified i.

Element &	GetElementRef (int i)
	Get reference to element at specified i.

void	SetElement (int i, const Element &value)
	Set element at specified i.

void	SetAllElements (const Element &value)
	Set some value to all elements.

void	Reset ()
	Set all coordinates to zero.

void	Clear ()
	Set all coordinates to zero.

const TVector< Size, Element >::Elements &	GetElements () const
	Get read-only access to internal element container.

TVector< Size, Element >::Elements &	GetElementsRef ()
	Get access to internal element container.

void	Translate (const TVector< Size, Element > &vector)
	Translate the point.

TVector< Size, Element >	GetTranslated (const TVector< Size, Element > &vector)
	Get translated point.

void	GetTranslated (const TVector< Size, Element > &vector, TVector< Size, Element > &result)
	/overloaded

void	ScaledCumulate (const TVector< Size, Element > &vector, Element scale)
	Add second vector scaled by specified factor.

bool	IsNull (Element tolerance=I_BIG_EPSILON) const
	Check if this vector is null.

Element	GetDotProduct (const TVector< Size, Element > &vector) const
	Return dot product of two vectors.

Element	GetLength2 () const
	Return euclidian length square.

Element	GetLength () const
	Return euclidian length.

Element	GetDistance2 (const TVector< Size, Element > &vector) const
	Return distance square between two vectors.

Element	GetDistance (const TVector< Size, Element > &vector) const
	Return distance between two vectors.

Element	GetElementsSum () const
	Get simple sum of all elements.

bool	Normalize (Element length=1.0)
	Normalize vector to specified length.

bool	GetNormalized (TVector< Size, Element > &result, Element length=1.0) const
	Return normalized vector with the same direction and specified length.

void	GetMinimal (const TVector< Size, Element > &vector, TVector< Size, Element > &result) const
	Get vector with minimal elements values.

void	GetMaximal (const TVector< Size, Element > &vector, TVector< Size, Element > &result) const
	Get vector with maximal elements values.

bool	Serialize (iser::IArchive &archive)
	Serialize this vector to specified archive.

bool	operator== (const TVector< Size, Element > &vector) const

bool	operator!= (const TVector< Size, Element > &vector) const

bool	operator< (const TVector< Size, Element > &vector) const

bool	operator> (const TVector< Size, Element > &vector) const

bool	operator<= (const TVector< Size, Element > &vector) const

bool	operator>= (const TVector< Size, Element > &vector) const

TVector< Size, Element >	operator- () const

TVector< Size, Element >	operator+ (const TVector< Size, Element > &vector) const

TVector< Size, Element >	operator- (const TVector< Size, Element > &vector) const

TVector< Size, Element >	operator* (Element scalar) const

TVector< Size, Element >	operator/ (Element scalar) const

TVector< Size, Element > &	operator= (const TVector< Size, Element > &vector)

TVector< Size, Element > &	operator= (TVector< Size, Element > &&vector)

TVector< Size, Element > &	operator+= (const TVector< Size, Element > &vector)

TVector< Size, Element > &	operator-= (const TVector< Size, Element > &vector)

TVector< Size, Element > &	operator*= (Element scalar)

TVector< Size, Element > &	operator/= (Element scalar)

const Element &	operator[] (int i) const

Element &	operator[] (int i)

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 std::unique_ptr< 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 QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

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.

Additional Inherited Members
Static Public Member Functions inherited from imath::TVector< Size, Element >
static int	GetElementsCount ()
	Get number of elements.

static bool	SetElementsCount (int count)
	Set number of elements.

static const TVector< Size, Element > &	GetZero ()
	Get vector with all coordinates set to 0.

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.

Protected Attributes inherited from imath::TVector< Size, Element >
Elements	m_elements

Detailed Description

Primitive for representation of HSV color value.

Please note, that normal components values are in range [0, 1].

Definition at line 22 of file CHsv.h.

Member Typedef Documentation

◆ BaseClass

TComposedColor<3> icmm::CHsv::BaseClass

Definition at line 25 of file CHsv.h.

Member Enumeration Documentation

◆ ComponentIndex

enum icmm::CHsv::ComponentIndex

Enumerator
CI_HUE
CI_SATURATION
CI_VALUE
CI_LAST

Definition at line 27 of file CHsv.h.

Constructor & Destructor Documentation

◆ CHsv() [1/3]

icmm::CHsv::CHsv	(	double	h = 0.0,
		double	s = 0.0,
		double	v = 0.0 )

inline

Definition at line 72 of file CHsv.h.

References CI_HUE, CI_SATURATION, CI_VALUE, and imath::TVector< Size, Element >::SetElement().

◆ CHsv() [2/3]

icmm::CHsv::CHsv ( const CHsv & color )

inline

Definition at line 80 of file CHsv.h.

◆ CHsv() [3/3]

icmm::CHsv::CHsv ( const imath::CVarVector & vector )

inline

Definition at line 86 of file CHsv.h.

Member Function Documentation

◆ GetHue()

double icmm::CHsv::GetHue ( ) const

inline

Definition at line 94 of file CHsv.h.

References CI_HUE, and imath::TVector< Size, Element >::GetElement().

◆ GetSaturation()

double icmm::CHsv::GetSaturation ( ) const

inline

Definition at line 106 of file CHsv.h.

References CI_SATURATION, and imath::TVector< Size, Element >::GetElement().

◆ GetValue()

double icmm::CHsv::GetValue ( ) const

inline

Definition at line 118 of file CHsv.h.

References CI_VALUE, and imath::TVector< Size, Element >::GetElement().

◆ operator*() [1/2]

CHsv icmm::CHsv::operator* ( const CHsv & color ) const

◆ operator*() [2/2]

CHsv icmm::CHsv::operator* ( double value ) const

◆ operator*=() [1/2]

const CHsv & icmm::CHsv::operator*= ( const CHsv & color )

inline

Definition at line 157 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator*=().

◆ operator*=() [2/2]

const CHsv & icmm::CHsv::operator*= ( double value )

inline

Definition at line 173 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator*=().

◆ operator+()

CHsv icmm::CHsv::operator+ ( const CHsv & color ) const

◆ operator+=()

const CHsv & icmm::CHsv::operator+= ( const CHsv & color )

inline

Definition at line 141 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator+=().

◆ operator-()

CHsv icmm::CHsv::operator- ( const CHsv & color ) const

◆ operator-=()

const CHsv & icmm::CHsv::operator-= ( const CHsv & color )

inline

Definition at line 149 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator-=().

◆ operator/() [1/2]

CHsv icmm::CHsv::operator/ ( const CHsv & color ) const

◆ operator/() [2/2]

CHsv icmm::CHsv::operator/ ( double value ) const

◆ operator/=() [1/2]

const CHsv & icmm::CHsv::operator/= ( const CHsv & color )

inline

Definition at line 165 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator/=().

◆ operator/=() [2/2]

const CHsv & icmm::CHsv::operator/= ( double value )

inline

Definition at line 181 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator/=().

◆ operator=()

CHsv & icmm::CHsv::operator= ( const CHsv & color )

inline

Definition at line 133 of file CHsv.h.

References icmm::TComposedColor< 3 >::operator=().

◆ Serialize()

bool icmm::CHsv::Serialize ( iser::IArchive & archive )

virtual

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

Type of operation is depending on archive type.

See also: iser::IArchive

Reimplemented from icmm::TComposedColor< 3 >.

◆ SetHue()

void icmm::CHsv::SetHue ( double value )

inline

Definition at line 100 of file CHsv.h.

References CI_HUE, and imath::TVector< Size, Element >::SetElement().

◆ SetSaturation()

void icmm::CHsv::SetSaturation ( double value )

inline

Definition at line 112 of file CHsv.h.

References CI_SATURATION, and imath::TVector< Size, Element >::SetElement().

◆ SetValue()

void icmm::CHsv::SetValue ( double value )

inline

Definition at line 124 of file CHsv.h.

References CI_VALUE, and imath::TVector< Size, Element >::SetElement().

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

icmm/CHsv.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ ComponentIndex

Constructor & Destructor Documentation

◆ CHsv() [1/3]

◆ CHsv() [2/3]

◆ CHsv() [3/3]

Member Function Documentation

◆ GetHue()

◆ GetSaturation()

◆ GetValue()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=()

◆ Serialize()

◆ SetHue()

◆ SetSaturation()

◆ SetValue()