visualSignaturePropagatorDesc.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: visualSignaturePropagatorDesc.h,v $ $Revision: 1.4 $ $State: Exp $
** Created: 6/10/08 MEM
*******************************************************************************/



#ifndef visualSignaturePropagatorDesc_H_
#define visualSignaturePropagatorDesc_H_

#include "vrfobjparam/standardPropagatorDesc.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwObjType.h"
#include "vrfobjparam/vrfobjparamDefines.h"

class DT_DLL_vrfobjparam DtVisualSignaturePropagatorDescriptor : public DtStandardPropagatorDescriptor
{
public:
   DtVisualSignaturePropagatorDescriptor(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVisualSignaturePropagatorDescriptor(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVisualSignaturePropagatorDescriptor(const DtVisualSignaturePropagatorDescriptor& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVisualSignaturePropagatorDescriptor& operator=(
      const DtVisualSignaturePropagatorDescriptor& orig);

   virtual ~DtVisualSignaturePropagatorDescriptor();

   virtual DtString type() const;

   virtual DtSignaturePropagatorDescriptor* clone(
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   static DtSignaturePropagatorDescriptor* creator();

   virtual double reductionFactor() const;
   virtual void setReductionFactor(double factor);

   virtual bool checkSmokeIntersections() const;
   virtual void setCheckSmokeIntersections(bool check);

   virtual const DtObjectType & smokeType() const;
   virtual void setSmokeType(const DtObjectType & type);

   virtual double minSmokeBlockDistance() const;
   virtual void setMinSmokeBlockDistance(double value);

   virtual double minSmokeBlockDensity() const;
   virtual void setMinSmokeBlockDensity(double value);

private:
   DtVisualSignaturePropagatorDescriptor();

protected:

   DtRwReal       myReductionFactor;

   DtRwBoolean    myCheckSmoke;

   DtRwObjectType mySmokeType;

   DtRwReal myMinSmokeBlockDistance;

   DtRwReal myMinSmokeBlockDensity;

};

#endif