AECDbStairStyle.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 __AECDBSTAIRSTYLE_H__
#define __AECDBSTAIRSTYLE_H__
 
#include "DbObject/AECDbDictRecord.h"
#include "AECArchBaseDefs.h"
 
class AECStairCompDef;
typedef OdSmartPtr<AECStairCompDef> AECStairCompDefPtr;
typedef AECSubPtr<AECStairCompDef>  AECStairCompDefSubPtr;
 
class AECARCHBASE_API AECDbStairStyle : public AECDbDictRecord
{
    AEC_DECLARE_MEMBERS( AECDbStairStyle );
 
    AEC_DICTIONARY_DECLARE_MEMBERS( AECDbStairStyle );
 
    public:
        bool IsAllowVaryComponents() const;
 
        void SetIsAllowVaryComponents( bool bAllow );
 
        bool IsDisplayRisers() const;
 
        void SetIsDisplayRisers( bool bDisplay );
 
        bool IsDisplayTreads() const;
 
        void SetIsDisplayTreads( bool bDisplay );
 
        double GetTreadThickness() const;
 
        void SetTreadThickness( double dThickness );
 
        double GetRiserThickness() const;
 
        void SetRiserThickness( double dThickness );
 
        double GetLandingThickness() const;
 
        void SetLandingThickness( double dThickness );
 
        double GetAdditionalWidth() const;
 
        void SetAdditionalWidth( double dWidth );
 
        double GetNosingLength() const;
 
        void SetNosingLength( double dLength );
 
        bool IsSlopingRisers() const;
 
        void SetIsSlopingRisers( bool bSloping );
 
        bool IsAllowVaryLandingExtensions() const;
 
        void SetIsAllowVaryLandingExtensions( bool bAllow );
 
        double GetDistanceToFirstTreadUp() const;
 
        void SetDistanceToFirstTreadUp( double dDistance );
 
        double GetDistanceToFirstTreadDown() const;
 
        void SetDistanceToFirstTreadDown( double dDistance );
 
        bool IsAddTreadDepthUp() const;
 
        void SetIsAddTreadDepthUp( bool bAdd );
 
        bool IsAddTreadDepthDown() const;
 
        void SetIsAddTreadDepthDown( bool bAdd );
 
        double GetLandingLength() const;
 
        void SetLandingLength( double dLength );
 
        AECDefs::StairLandingLocation GetLandingLocation() const;
 
        void SetLandingLocation( AECDefs::StairLandingLocation eLocation );
 
        bool IsExtendToMergeStringers() const;
 
        void SetIsExtendToMergeStringers( bool bExtend );
 
        bool IsExtendToPreventRisersSittingUnderLandings() const;
 
        void SetIsExtendToPreventRisersSittingUnderLandings( bool bExtend );
 
        OdUInt32 GetComponentCount() const;
 
        AECStairCompDefSubPtr GetComponentByIndex( OdUInt32 iIndex ) const;
 
        AECImpArraySubPtr GetComponents() const;
 
        bool IsUseRuleBasedCalculator() const;
 
        void SetIsUseRuleBasedCalculator( bool bUse );
 
        double GetRuleMinLimit() const;
 
        void SetRuleMinLimit( double dLimit );
 
        double GetRuleMaxLimit() const;
 
        void SetRuleMaxLimit( double dLimit );
 
        double GetRiserHeightMult() const;
 
        void SetRiserHeightMult( double dMult );
 
        double GetTreadDepthMult() const;
 
        void SetTreadDepthMult( double dMult );
 
        const OdDbObjectId& GetTreadMaterial() const;
 
        void SetTreadMaterial( const OdDbObjectId& id );
 
        const OdDbObjectId& GetRiserMaterial() const;
 
        void SetRiserMaterial( const OdDbObjectId& id );
 
        const OdDbObjectId& GetLandingMaterial() const;
 
        void SetLandingMaterial( const OdDbObjectId& id );
 
        double GetMinSlopeRiserHeight() const;
 
        void SetMinSlopeRiserHeight( double dHeight );
 
        double GetOptSlopeRiserHeight() const;
 
        void SetOptSlopeRiserHeight( double dHeight );
 
        double GetMaxSlopeRiserHeight() const;
 
        void SetMaxSlopeRiserHeight( double dHeight );
 
        double GetMinSlopeTreadDepth() const;
 
        void SetMinSlopeTreadDepth( double dDepth );
 
        double GetOptSlopeTreadDepth() const;
 
        void SetOptSlopeTreadDepth( double dDepth );
 
        double GetMaxSlopeTreadDepth() const;
 
        void SetMaxSlopeTreadDepth( double dDepth );
};
 
typedef OdSmartPtr<AECDbStairStyle> AECDbStairStylePtr;
 
#endif // __AECDBSTAIRSTYLE_H__