Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
osg::DisplayCalibrationBase

osg::DisplayCalibrationBase Class Reference

DisplayCalibration Base Class.

#include <OSGDisplayCalibrationBase.h>

Inheritance diagram for osg::DisplayCalibrationBase:

osg::AttachmentContainer osg::FieldContainer osg::DisplayCalibration List of all members.

Public Types

typedef DisplayCalibrationPtr Ptr
enum  {
  EnabledFieldId = Inherited::NextFieldId, ServerFieldId = EnabledFieldId + 1, ColorMatrixFieldId = ServerFieldId + 1, GammaFieldId = ColorMatrixFieldId + 1,
  GammaRampFieldId = GammaFieldId + 1, GridWidthFieldId = GammaRampFieldId + 1, GridHeightFieldId = GridWidthFieldId + 1, GridFieldId = GridHeightFieldId + 1,
  ScaleDownFieldId = GridFieldId + 1, NextFieldId = ScaleDownFieldId + 1
}

Public Member Functions

FieldContainer Get
*virtual FieldContainerType & getType (void)
virtual const FieldContainerType & getType (void) const
virtual UInt32 getContainerSize (void) const
Field Get
*SFBool * getSFEnabled (void)
 Get the DisplayCalibration::_sfEnabled field.
SFString * getSFServer (void)
 Get the DisplayCalibration::_sfServer field.
SFMatrix * getSFColorMatrix (void)
 Get the DisplayCalibration::_sfColorMatrix field.
SFReal32 * getSFGamma (void)
 Get the DisplayCalibration::_sfGamma field.
MFColor3f * getMFGammaRamp (void)
 Get the DisplayCalibration::_mfGammaRamp field.
SFUInt32 * getSFGridWidth (void)
 Get the DisplayCalibration::_sfGridWidth field.
SFUInt32 * getSFGridHeight (void)
 Get the DisplayCalibration::_sfGridHeight field.
MFVec2f * getMFGrid (void)
 Get the DisplayCalibration::_mfGrid field.
SFReal32 * getSFScaleDown (void)
 Get the DisplayCalibration::_sfScaleDown field.
bool & getEnabled (void)
 Get the value of the DisplayCalibration::_sfEnabled field.
const bool & getEnabled (void) const
 Get the value of the DisplayCalibration::_sfEnabled field.
std::string & getServer (void)
 Get the value of the DisplayCalibration::_sfServer field.
const std::string & getServer (void) const
 Get the value of the DisplayCalibration::_sfServer field.
Matrix & getColorMatrix (void)
 Get the value of the DisplayCalibration::_sfColorMatrix field.
const Matrix & getColorMatrix (void) const
 Get the value of the DisplayCalibration::_sfColorMatrix field.
Real32 & getGamma (void)
 Get the value of the DisplayCalibration::_sfGamma field.
const Real32 & getGamma (void) const
 Get the value of the DisplayCalibration::_sfGamma field.
UInt32 & getGridWidth (void)
 Get the value of the DisplayCalibration::_sfGridWidth field.
const UInt32 & getGridWidth (void) const
 Get the value of the DisplayCalibration::_sfGridWidth field.
UInt32 & getGridHeight (void)
 Get the value of the DisplayCalibration::_sfGridHeight field.
const UInt32 & getGridHeight (void) const
 Get the value of the DisplayCalibration::_sfGridHeight field.
Real32 & getScaleDown (void)
 Get the value of the DisplayCalibration::_sfScaleDown field.
const Real32 & getScaleDown (void) const
 Get the value of the DisplayCalibration::_sfScaleDown field.
Color3f & getGammaRamp (const UInt32 index)
 Get the value of the index element the DisplayCalibration::_mfGammaRamp field.
MFColor3f & getGammaRamp (void)
 Get the DisplayCalibration::_mfGammaRamp field.
const MFColor3f & getGammaRamp (void) const
 Get the DisplayCalibration::_mfGammaRamp field.
Vec2f & getGrid (const UInt32 index)
 Get the value of the index element the DisplayCalibration::_mfGrid field.
MFVec2f & getGrid (void)
 Get the DisplayCalibration::_mfGrid field.
const MFVec2f & getGrid (void) const
 Get the DisplayCalibration::_mfGrid field.
Field Set
*void setEnabled (const bool &value)
 Set the value of the DisplayCalibration::_sfEnabled field.
void setServer (const std::string &value)
 Set the value of the DisplayCalibration::_sfServer field.
void setColorMatrix (const Matrix &value)
 Set the value of the DisplayCalibration::_sfColorMatrix field.
void setGamma (const Real32 &value)
 Set the value of the DisplayCalibration::_sfGamma field.
void setGridWidth (const UInt32 &value)
 Set the value of the DisplayCalibration::_sfGridWidth field.
void setGridHeight (const UInt32 &value)
 Set the value of the DisplayCalibration::_sfGridHeight field.
void setScaleDown (const Real32 &value)
 Set the value of the DisplayCalibration::_sfScaleDown field.
Binary Access
*virtual UInt32 getBinSize (const BitVector &whichField)
virtual void copyToBin (BinaryDataHandler &pMem, const BitVector &whichField)
virtual void copyFromBin (BinaryDataHandler &pMem, const BitVector &whichField)
Copy
*virtual FieldContainerPtr shallowCopy (void) const
Handle Attachments
*void addAttachment (const AttachmentPtr &fieldContainerP, UInt16 binding=0)
void subAttachment (const AttachmentPtr &fieldContainerP, UInt16 binding=0)
AttachmentPtr findAttachment (UInt32 groupId, UInt16 binding=0)
AttachmentPtr findAttachment (const FieldContainerType &type, UInt16 binding=0)
Field Access *SFAttachmentMap * getSFAttachments (void)
Changed
*virtual void changed (BitVector whichField, UInt32 origin)
Dump
*virtual void dump (UInt32 uiIndent=0, const BitVector bvFlags=0) const

Static Public Member Functions

Class Get
*static FieldContainerType & getClassType (void)
 access the type of the class
static UInt32 getClassTypeId (void)
 access the numerical type of the class
Construction
*static DisplayCalibrationPtr create (void)
 create a new instance of the class
static DisplayCalibrationPtr createEmpty (void)
 create an empty new instance of the class, do not copy the prototype

Static Public Attributes

static const osg::BitVector EnabledFieldMask
static const osg::BitVector ServerFieldMask
static const osg::BitVector ColorMatrixFieldMask
static const osg::BitVector GammaFieldMask
static const osg::BitVector GammaRampFieldMask
static const osg::BitVector GridWidthFieldMask
static const osg::BitVector GridHeightFieldMask
static const osg::BitVector GridFieldMask
static const osg::BitVector ScaleDownFieldMask
static const osg::BitVector MTInfluenceMask
static const BitVector AttachmentsFieldMask
static const BitVector NextFieldMask

Protected Member Functions

Constructors
* DisplayCalibrationBase (void)
 DisplayCalibrationBase (const DisplayCalibrationBase &source)
Destructors
*virtual ~DisplayCalibrationBase (void)
Sync
*void executeSyncImpl (DisplayCalibrationBase *pOther, const BitVector &whichField)
virtual void executeSync (FieldContainer &other, const BitVector &whichField)
Sync
void executeSyncImpl (AttachmentContainer *pOther, const BitVector &whichField)
Pointer
*AttachmentContainerPtr getPtr (void)
MT Destruction
*virtual void onDestroy (void)

Protected Attributes

Fields
*SFBool _sfEnabled
SFString _sfServer
SFMatrix _sfColorMatrix
SFReal32 _sfGamma
MFColor3f _mfGammaRamp
SFUInt32 _sfGridWidth
SFUInt32 _sfGridHeight
MFVec2f _mfGrid
SFReal32 _sfScaleDown
Fields
*SFAttachmentMap _attachmentMap

Private Types

typedef AttachmentContainer Inherited

Private Member Functions

void operator= (const DisplayCalibrationBase &source)

Static Private Attributes

static FieldDescription * _desc []
 DisplayCalibration description.
static FieldContainerType _type

Friends

class FieldContainer

Detailed Description

Definition at line 89 of file OSGDisplayCalibrationBase.h.

Member Typedef Documentation

typedef AttachmentContainer osg::DisplayCalibrationBase::Inherited [private]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::DisplayCalibration.

Definition at line 93 of file OSGDisplayCalibrationBase.h.

typedef DisplayCalibrationPtr osg::DisplayCalibrationBase::Ptr
 

Definition at line 98 of file OSGDisplayCalibrationBase.h.

Member Enumeration Documentation

anonymous enum
 

Enumerator:
EnabledFieldId 
ServerFieldId 
ColorMatrixFieldId 
GammaFieldId 
GammaRampFieldId 
GridWidthFieldId 
GridHeightFieldId 
GridFieldId 
ScaleDownFieldId 
NextFieldId 

Reimplemented from osg::AttachmentContainer.

Definition at line 100 of file OSGDisplayCalibrationBase.h.

00101     {
00102         EnabledFieldId     = Inherited::NextFieldId,
00103         ServerFieldId      = EnabledFieldId     + 1,
00104         ColorMatrixFieldId = ServerFieldId      + 1,
00105         GammaFieldId       = ColorMatrixFieldId + 1,
00106         GammaRampFieldId   = GammaFieldId       + 1,
00107         GridWidthFieldId   = GammaRampFieldId   + 1,
00108         GridHeightFieldId  = GridWidthFieldId   + 1,
00109         GridFieldId        = GridHeightFieldId  + 1,
00110         ScaleDownFieldId   = GridFieldId        + 1,
00111         NextFieldId        = ScaleDownFieldId   + 1
00112     };

Constructor & Destructor Documentation

DisplayCalibrationBase::DisplayCalibrationBase (  void   )  [protected]
 

Definition at line 254 of file OSGDisplayCalibrationBase.cpp.

00254                                                    :
00255     _sfEnabled                (bool(true)), 
00256     _sfServer                 (), 
00257     _sfColorMatrix            (), 
00258     _sfGamma                  (Real32(1)), 
00259     _mfGammaRamp              (), 
00260     _sfGridWidth              (UInt32(0)), 
00261     _sfGridHeight             (UInt32(0)), 
00262     _mfGrid                   (), 
00263     _sfScaleDown              (Real32(1.0)), 
00264     Inherited() 
00265 {
00266 }

DisplayCalibrationBase::DisplayCalibrationBase (  const DisplayCalibrationBase &  source  )  [protected]
 

Definition at line 272 of file OSGDisplayCalibrationBase.cpp.

00272                                                                                    :
00273     _sfEnabled                (source._sfEnabled                ), 
00274     _sfServer                 (source._sfServer                 ), 
00275     _sfColorMatrix            (source._sfColorMatrix            ), 
00276     _sfGamma                  (source._sfGamma                  ), 
00277     _mfGammaRamp              (source._mfGammaRamp              ), 
00278     _sfGridWidth              (source._sfGridWidth              ), 
00279     _sfGridHeight             (source._sfGridHeight             ), 
00280     _mfGrid                   (source._mfGrid                   ), 
00281     _sfScaleDown              (source._sfScaleDown              ), 
00282     Inherited                 (source)
00283 {
00284 }

DisplayCalibrationBase::~DisplayCalibrationBase (  void   )  [protected, virtual]
 

Definition at line 288 of file OSGDisplayCalibrationBase.cpp.

00289 {
00290 }

Member Function Documentation

osg::FieldContainerType & osg::DisplayCalibrationBase::getClassType (  void   )  [inline, static]
 

Reimplemented from osg::AttachmentContainer.

Definition at line 58 of file OSGDisplayCalibrationBase.inl.

References _type.

Referenced by create().

00059 {
00060     return _type; 
00061 }

osg::UInt32 osg::DisplayCalibrationBase::getClassTypeId (  void   )  [inline, static]
 

Reimplemented from osg::AttachmentContainer.

Definition at line 65 of file OSGDisplayCalibrationBase.inl.

References _type, and osg::TypeBase::getId().

00066 {
00067     return _type.getId(); 
00068 }

FieldContainerType & DisplayCalibrationBase::getType (  void   )  [virtual]
 

Reimplemented from osg::AttachmentContainer.

Definition at line 194 of file OSGDisplayCalibrationBase.cpp.

References _type.

00195 {
00196     return _type; 
00197 }

const FieldContainerType & DisplayCalibrationBase::getType (  void   )  const [virtual]
 

Reimplemented from osg::AttachmentContainer.

Definition at line 199 of file OSGDisplayCalibrationBase.cpp.

References _type.

00200 {
00201     return _type;
00202 }

UInt32 DisplayCalibrationBase::getContainerSize (  void   )  const [virtual]
 

Reimplemented from osg::AttachmentContainer.

Definition at line 214 of file OSGDisplayCalibrationBase.cpp.

00215 { 
00216     return sizeof(DisplayCalibration); 
00217 }

SFBool * osg::DisplayCalibrationBase::getSFEnabled (  void   )  [inline]
 

Definition at line 101 of file OSGDisplayCalibrationBase.inl.

References _sfEnabled.

00102 {
00103     return &_sfEnabled;
00104 }

SFString * osg::DisplayCalibrationBase::getSFServer (  void   )  [inline]
 

Definition at line 108 of file OSGDisplayCalibrationBase.inl.

References _sfServer.

00109 {
00110     return &_sfServer;
00111 }

SFMatrix * osg::DisplayCalibrationBase::getSFColorMatrix (  void   )  [inline]
 

Definition at line 115 of file OSGDisplayCalibrationBase.inl.

References _sfColorMatrix.

00116 {
00117     return &_sfColorMatrix;
00118 }

SFReal32 * osg::DisplayCalibrationBase::getSFGamma (  void   )  [inline]
 

Definition at line 122 of file OSGDisplayCalibrationBase.inl.

References _sfGamma.

00123 {
00124     return &_sfGamma;
00125 }

MFColor3f * osg::DisplayCalibrationBase::getMFGammaRamp (  void   )  [inline]
 

Definition at line 129 of file OSGDisplayCalibrationBase.inl.

References _mfGammaRamp.

00130 {
00131     return &_mfGammaRamp;
00132 }

SFUInt32 * osg::DisplayCalibrationBase::getSFGridWidth (  void   )  [inline]
 

Definition at line 136 of file OSGDisplayCalibrationBase.inl.

References _sfGridWidth.

00137 {
00138     return &_sfGridWidth;
00139 }

SFUInt32 * osg::DisplayCalibrationBase::getSFGridHeight (  void   )  [inline]
 

Definition at line 143 of file OSGDisplayCalibrationBase.inl.

References _sfGridHeight.

00144 {
00145     return &_sfGridHeight;
00146 }

MFVec2f * osg::DisplayCalibrationBase::getMFGrid (  void   )  [inline]
 

Definition at line 150 of file OSGDisplayCalibrationBase.inl.

References _mfGrid.

00151 {
00152     return &_mfGrid;
00153 }

SFReal32 * osg::DisplayCalibrationBase::getSFScaleDown (  void   )  [inline]
 

Definition at line 157 of file OSGDisplayCalibrationBase.inl.

References _sfScaleDown.

00158 {
00159     return &_sfScaleDown;
00160 }

bool & osg::DisplayCalibrationBase::getEnabled (  void   )  [inline]
 

Definition at line 165 of file OSGDisplayCalibrationBase.inl.

References _sfEnabled, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::DisplayCalibration::calibrate().

00166 {
00167     return _sfEnabled.getValue();
00168 }

const bool & osg::DisplayCalibrationBase::getEnabled (  void   )  const [inline]
 

Definition at line 172 of file OSGDisplayCalibrationBase.inl.

References _sfEnabled, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00173 {
00174     return _sfEnabled.getValue();
00175 }

std::string & osg::DisplayCalibrationBase::getServer (  void   )  [inline]
 

Definition at line 186 of file OSGDisplayCalibrationBase.inl.

References _sfServer, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00187 {
00188     return _sfServer.getValue();
00189 }

const std::string & osg::DisplayCalibrationBase::getServer (  void   )  const [inline]
 

Definition at line 193 of file OSGDisplayCalibrationBase.inl.

References _sfServer, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00194 {
00195     return _sfServer.getValue();
00196 }

Matrix & osg::DisplayCalibrationBase::getColorMatrix (  void   )  [inline]
 

Definition at line 207 of file OSGDisplayCalibrationBase.inl.

References _sfColorMatrix, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::DisplayCalibration::updateMatrix().

00208 {
00209     return _sfColorMatrix.getValue();
00210 }

const Matrix & osg::DisplayCalibrationBase::getColorMatrix (  void   )  const [inline]
 

Definition at line 214 of file OSGDisplayCalibrationBase.inl.

References _sfColorMatrix, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00215 {
00216     return _sfColorMatrix.getValue();
00217 }

Real32 & osg::DisplayCalibrationBase::getGamma (  void   )  [inline]
 

Definition at line 228 of file OSGDisplayCalibrationBase.inl.

References _sfGamma, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::DisplayCalibration::updateGamma().

00229 {
00230     return _sfGamma.getValue();
00231 }

const Real32 & osg::DisplayCalibrationBase::getGamma (  void   )  const [inline]
 

Definition at line 235 of file OSGDisplayCalibrationBase.inl.

References _sfGamma, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00236 {
00237     return _sfGamma.getValue();
00238 }

UInt32 & osg::DisplayCalibrationBase::getGridWidth (  void   )  [inline]
 

Definition at line 249 of file OSGDisplayCalibrationBase.inl.

References _sfGridWidth, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::DisplayCalibration::createCMViewports().

00250 {
00251     return _sfGridWidth.getValue();
00252 }

const UInt32 & osg::DisplayCalibrationBase::getGridWidth (  void   )  const [inline]
 

Definition at line 256 of file OSGDisplayCalibrationBase.inl.

References _sfGridWidth, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00257 {
00258     return _sfGridWidth.getValue();
00259 }

UInt32 & osg::DisplayCalibrationBase::getGridHeight (  void   )  [inline]
 

Definition at line 270 of file OSGDisplayCalibrationBase.inl.

References _sfGridHeight, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::DisplayCalibration::createCMViewports().

00271 {
00272     return _sfGridHeight.getValue();
00273 }

const UInt32 & osg::DisplayCalibrationBase::getGridHeight (  void   )  const [inline]
 

Definition at line 277 of file OSGDisplayCalibrationBase.inl.

References _sfGridHeight, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00278 {
00279     return _sfGridHeight.getValue();
00280 }

Real32 & osg::DisplayCalibrationBase::getScaleDown (  void   )  [inline]
 

Definition at line 291 of file OSGDisplayCalibrationBase.inl.

References _sfScaleDown, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::DisplayCalibration::calibrate(), and osg::DisplayCalibration::createCMViewports().

00292 {
00293     return _sfScaleDown.getValue();
00294 }

const Real32 & osg::DisplayCalibrationBase::getScaleDown (  void   )  const [inline]
 

Definition at line 298 of file OSGDisplayCalibrationBase.inl.

References _sfScaleDown, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00299 {
00300     return _sfScaleDown.getValue();
00301 }

Color3f & osg::DisplayCalibrationBase::getGammaRamp (  const UInt32  index  )  [inline]
 

Definition at line 313 of file OSGDisplayCalibrationBase.inl.

References _mfGammaRamp.

00314 {
00315     return _mfGammaRamp[index];
00316 }

MFColor3f & osg::DisplayCalibrationBase::getGammaRamp (  void   )  [inline]
 

Definition at line 320 of file OSGDisplayCalibrationBase.inl.

References _mfGammaRamp.

Referenced by osg::DisplayCalibration::createCMViewports(), and osg::DisplayCalibration::updateGamma().

00321 {
00322     return _mfGammaRamp;
00323 }

const MFColor3f & osg::DisplayCalibrationBase::getGammaRamp (  void   )  const [inline]
 

Definition at line 327 of file OSGDisplayCalibrationBase.inl.

References _mfGammaRamp.

00328 {
00329     return _mfGammaRamp;
00330 }

Vec2f & osg::DisplayCalibrationBase::getGrid (  const UInt32  index  )  [inline]
 

Definition at line 334 of file OSGDisplayCalibrationBase.inl.

References _mfGrid.

00335 {
00336     return _mfGrid[index];
00337 }

MFVec2f & osg::DisplayCalibrationBase::getGrid (  void   )  [inline]
 

Definition at line 341 of file OSGDisplayCalibrationBase.inl.

References _mfGrid.

Referenced by osg::DisplayCalibration::createCMViewports().

00342 {
00343     return _mfGrid;
00344 }

const MFVec2f & osg::DisplayCalibrationBase::getGrid (  void   )  const [inline]
 

Definition at line 348 of file OSGDisplayCalibrationBase.inl.

References _mfGrid.

00349 {
00350     return _mfGrid;
00351 }

void osg::DisplayCalibrationBase::setEnabled (  const bool &  value  )  [inline]
 

Definition at line 179 of file OSGDisplayCalibrationBase.inl.

References _sfEnabled, and osg::SField< FieldTypeT, fieldNameSpace >::setValue().

00180 {
00181     _sfEnabled.setValue(value);
00182 }

void osg::DisplayCalibrationBase::setServer (  const std::string &  value  )  [inline]
 

Definition at line 200 of file OSGDisplayCalibrationBase.inl.

References _sfServer, and osg::SField< FieldTypeT, fieldNameSpace >::setValue().

00201 {
00202     _sfServer.setValue(value);
00203 }

void osg::DisplayCalibrationBase::setColorMatrix (  const Matrix &  value  )  [inline]
 

Definition at line 221 of file OSGDisplayCalibrationBase.inl.

References _sfColorMatrix, and osg::SField< FieldTypeT, fieldNameSpace >::setValue().

00222 {
00223