DbLSStrokePatternComponent.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef ODDGNLS_DBLSSTROKEPATTERNCOMPONENT_H
#define ODDGNLS_DBLSSTROKEPATTERNCOMPONENT_H
 
#include "DbLSComponent.h"
#include "DbLSStroke.h"
 
#include "TD_PackPush.h"
 
class ODDGNLS_EXPORT OdDbLSStrokePatternComponent : public OdDbLSComponent
{
  public:
    enum PhaseMode
    {
      kLSPhaseDistance = 0, // Distance phase mode
      kLSPhaseFraction = 1, // Fraction phase mode (auto phase)
      kLSPhaseCentered = 2  // Centered phase mode (stretch phase mode)
    };
  public:
    ODDB_DECLARE_MEMBERS(OdDbLSStrokePatternComponent);
 
    OdDbLSStrokePatternComponent();
 
    double autoPhase() const;
    void setAutoPhase(double fPhase);
 
    bool hasIterationLimit() const;
    void setHasIterationLimit(bool bSet);
 
    OdDbLSStroke *insertStroke(double fLength = 1.0, double fStartWidth = 0.0, double fEndWidth = 0.0,
      OdDbLSStroke::WidthMode widthMode = OdDbLSStroke::kLSNoWidth, OdDbLSStroke::CapMode capMode = OdDbLSStroke::kLSCapsClosed);
    OdDbLSStroke *insertStroke(const OdDbLSStroke *pStroke);
    OdDbLSStroke *stroke(OdUInt32 nStroke) const;
 
    void deleteStroke(OdUInt32 nStroke);
 
    OdUInt32 numberStrokes() const;
 
    bool isSingleSegment() const;
    void setIsSingleSegment(bool bSet);
 
    OdInt32 iterationLimit() const;
    void setIterationLimit(OdInt32 nLimit);
 
    double phase() const;
    void setPhase(double fPhase);
 
    PhaseMode phaseMode() const;
    void setPhaseMode(PhaseMode mode);
};
 
typedef OdSmartPtr<OdDbLSStrokePatternComponent> OdDbLSStrokePatternComponentPtr;
 
#include "TD_PackPop.h"
 
#endif // ODDGNLS_DBLSSTROKEPATTERNCOMPONENT_H