Generic color implementation. More...

#include <TComposedColor.h>

Inheritance diagram for icmm::TComposedColor< Size >:

Collaboration diagram for icmm::TComposedColor< Size >:

Public Types
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
	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/ (const TComposedColor< Size > &color) const

TComposedColor< Size >	operator* (double value) 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/= (const TComposedColor< Size > &color)

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

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

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

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

template<int Size>
class icmm::TComposedColor< Size >

Generic color implementation.

Definition at line 30 of file TComposedColor.h.

Member Typedef Documentation

◆ BaseClass

template<int Size>

imath::TVector<Size> icmm::TComposedColor< Size >::BaseClass

Definition at line 33 of file TComposedColor.h.

◆ Elements

template<int Size>

BaseClass::Elements icmm::TComposedColor< Size >::Elements

Definition at line 34 of file TComposedColor.h.

Constructor & Destructor Documentation

◆ TComposedColor() [1/3]

template<int Size>

icmm::TComposedColor< Size >::TComposedColor ( )

inline

Definition at line 104 of file TComposedColor.h.

◆ TComposedColor() [2/3]

template<int Size>

icmm::TComposedColor< Size >::TComposedColor ( const BaseClass & value )

inline

Definition at line 111 of file TComposedColor.h.

◆ TComposedColor() [3/3]

template<int Size>

icmm::TComposedColor< Size >::TComposedColor ( const imath::CVarVector & vector )

inlineexplicit

Definition at line 118 of file TComposedColor.h.

References imath::CVarVector::GetElementsCount().

Member Function Documentation

◆ GetNormalized()

template<int Size>

void icmm::TComposedColor< Size >::GetNormalized ( TComposedColor< Size > & result ) const

Get normalized color.

Normalized values have all components in the range [0, 1].

Definition at line 357 of file TComposedColor.h.

References icmm::TComposedColor< Size >::Normalize().

◆ GetRounded()

template<int Size>

void icmm::TComposedColor< Size >::GetRounded	(	const imath::IDoubleManip &	manipulator,
		TComposedColor< Size > &	result )

Get color after components value rounding with specified precision.

Parameters

manipulator	manipulator object used to round single components.
result	result object.

Definition at line 318 of file TComposedColor.h.

References imath::TIValueManip< ValueType >::GetRounded().

◆ IsNormalized()

template<int Size>

bool icmm::TComposedColor< Size >::IsNormalized ( ) const

inline

Check if this color value is normalized.

Normalized values have all components in the range [0, 1].

Definition at line 139 of file TComposedColor.h.

◆ IsRoundedEqual()

template<int Size>

bool icmm::TComposedColor< Size >::IsRoundedEqual	(	const TComposedColor< Size > &	color,
		const imath::IDoubleManip &	manipulator ) const

Check if two values are equal after rounding.

Parameters

color	second color to comparision.
manipulator	value manipulator used to round single components.

Definition at line 327 of file TComposedColor.h.

References imath::TIValueManip< ValueType >::IsEqual().

◆ IsSimilar()

template<int Size>

bool icmm::TComposedColor< Size >::IsSimilar	(	const TComposedColor< Size > &	color,
		double	tolerance = I_BIG_EPSILON ) const

inline

Allows to compare two colors with tolerance.

Definition at line 132 of file TComposedColor.h.

◆ Normalize()

template<int Size>

void icmm::TComposedColor< Size >::Normalize ( )

Make this color to be normalized.

Normalized values have all components in the range [0, 1].

Definition at line 340 of file TComposedColor.h.

Referenced by icmm::TComposedColor< Size >::GetNormalized().

◆ operator*() [1/2]

template<int Size>

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

inline

Definition at line 180 of file TComposedColor.h.

◆ operator*() [2/2]

template<int Size>

TComposedColor< Size > icmm::TComposedColor< Size >::operator* ( double value ) const

inline

Definition at line 206 of file TComposedColor.h.

◆ operator*=() [1/2]

template<int Size>

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

inline

Definition at line 272 of file TComposedColor.h.

◆ operator*=() [2/2]

template<int Size>

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

inline

Definition at line 298 of file TComposedColor.h.

◆ operator+()

template<int Size>

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

inline

Definition at line 154 of file TComposedColor.h.

◆ operator+=()

template<int Size>

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

inline

Definition at line 254 of file TComposedColor.h.

◆ operator-()

template<int Size>

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

inline

Definition at line 167 of file TComposedColor.h.

◆ operator-=()

template<int Size>

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

inline

Definition at line 263 of file TComposedColor.h.

◆ operator/() [1/2]

template<int Size>

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

inline

Definition at line 193 of file TComposedColor.h.

◆ operator/() [2/2]

template<int Size>

TComposedColor< Size > icmm::TComposedColor< Size >::operator/ ( double value ) const

inline

Definition at line 219 of file TComposedColor.h.

◆ operator/=() [1/2]

template<int Size>

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

inline

Definition at line 285 of file TComposedColor.h.

◆ operator/=() [2/2]

template<int Size>

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

inline

Definition at line 307 of file TComposedColor.h.

◆ operator=() [1/2]

template<int Size>

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

inline

Definition at line 232 of file TComposedColor.h.

◆ operator=() [2/2]

template<int Size>

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

inline

Definition at line 243 of file TComposedColor.h.

◆ Serialize()

template<int Size>

bool icmm::TComposedColor< Size >::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

Implements iser::ISerializable.

Reimplemented in icmm::CCmy, icmm::CCmyk, icmm::CHsv, icmm::CLab, and icmm::CRgb.

Definition at line 368 of file TComposedColor.h.

References iser::IArchive::BeginMultiTag(), iser::IArchive::BeginTag(), iser::IArchive::EndTag(), iser::IArchive::IsChanging(), iser::IArchive::Process(), iser::CArchiveTag::TT_LEAF, and iser::CArchiveTag::TT_MULTIPLE.

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

icmm/TComposedColor.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ Elements

Constructor & Destructor Documentation

◆ TComposedColor() [1/3]

◆ TComposedColor() [2/3]

◆ TComposedColor() [3/3]

Member Function Documentation

◆ GetNormalized()

◆ GetRounded()

◆ IsNormalized()

◆ IsRoundedEqual()

◆ IsSimilar()

◆ Normalize()

◆ 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=() [1/2]

◆ operator=() [2/2]

◆ Serialize()