ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
icmm::ISpectralColorSpecification Class Referenceabstract

#include <ISpectralColorSpecification.h>

Inheritance diagram for icmm::ISpectralColorSpecification:
icmm::IColorSpecification icmm::ISpectrumInfoProvider iser::IObject istd::IChangeable iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic icmm::CSpectralColorSpecificationBase

Public Types

enum  SpectrumType { Reflective = 1 , Emissive , Transmissive , TotalTransmissive }
 
typedef std::shared_ptr< const ISpectralColorSpecificationConstSpectralColorSpecPtr
 
typedef std::shared_ptr< ISpectralColorSpecificationSpectralColorSpecPtr
 
- Public Types inherited from icmm::IColorSpecification
enum  SpecType { Tristimulus , Spectral }
 
typedef std::shared_ptr< const IColorSpecificationConstColorSpecPtr
 
typedef std::shared_ptr< IColorSpecificationColorSpecPtr
 
- 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
 

Public Member Functions

 I_DECLARE_ENUM (SpectrumType, Reflective, Emissive, Transmissive, TotalTransmissive)
 
virtual SpectrumType GetSpectrumType () const =0
 
- Public Member Functions inherited from icmm::IColorSpecification
 I_DECLARE_ENUM (SpecType, Tristimulus, Spectral)
 
- 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::IChangeableCloneMe (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 ()
 
- Public Member Functions inherited from icmm::ISpectrumInfoProvider
virtual const ISpectrumInfoGetSpectrumInfo () const =0
 

Protected Member Functions

virtual SpecType GetSpecificationType () const final
 Gets the logical type of the specification.
 
- 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 

Detailed Description

Definition at line 15 of file ISpectralColorSpecification.h.

Member Typedef Documentation

◆ ConstSpectralColorSpecPtr

Definition at line 20 of file ISpectralColorSpecification.h.

◆ SpectralColorSpecPtr

Definition at line 21 of file ISpectralColorSpecification.h.

Member Enumeration Documentation

◆ SpectrumType

Enumerator
Reflective 
Emissive 
Transmissive 
TotalTransmissive 

Definition at line 23 of file ISpectralColorSpecification.h.

Member Function Documentation

◆ GetSpecificationType()

IColorSpecification::SpecType icmm::ISpectralColorSpecification::GetSpecificationType ( ) const
inlinefinalprotectedvirtual

Gets the logical type of the specification.

Returns whether this is a tristimulus-based specification (3 values like RGB) or a spectral-based specification (full wavelength distribution).

Returns
SpecType indicating Tristimulus or Spectral
See also
SpecType

Implements icmm::IColorSpecification.

Definition at line 40 of file ISpectralColorSpecification.h.

References icmm::IColorSpecification::Spectral.

◆ GetSpectrumType()

virtual SpectrumType icmm::ISpectralColorSpecification::GetSpectrumType ( ) const
pure virtual

◆ I_DECLARE_ENUM()

icmm::ISpectralColorSpecification::I_DECLARE_ENUM ( SpectrumType  ,
Reflective  ,
Emissive  ,
Transmissive  ,
TotalTransmissive   
)

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