AECDbStair.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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 Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 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 __AECDBSTAIR_H__
#define __AECDBSTAIR_H__
 
#include "AECArchBaseDefs.h"
#include "DbEntity/AECDbGeo.h"
#include "Subobjects/Stair/AECStairCalculatorData.h"
#include "Subobjects/Stair/AECStairCreator.h"
#include "Subobjects/Stair/AECStairComponent.h"
#include "Subobjects/Stair/AECStairFlightSpan.h"
 
class AECDbStair;
typedef OdSmartPtr<AECDbStair> AECDbStairPtr;

class AECARCHBASE_API AECDbStair : public AECDbGeo
{
    AEC_DECLARE_MEMBERS( AECDbStair );
 
    CURVE_DECLARE_MEMBERS();
 
    public:
        // Destription:
        // Returns vertical orientation.
        AECDefs::StairVerticalOrientation GetVerticalOrientation() const;

        void SetVerticalOrientation( AECDefs::StairVerticalOrientation eOrientation );

        AECDefs::StairTerminateWith GetTerminateWith() const;

        void SetTerminateWith( AECDefs::StairTerminateWith eTerminateWith );

        bool IsSlopingRisers() const;

        void SetIsSlopingRisers( bool bSloping );

        double GetNosingLength() const;

        void SetNosingLength( double dNosingLength );

        double GetAdditionalWidth() const;

        void SetAdditionalWidth( double dWidth );

        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 );

        bool IsExtendToMergeStringers() const;

        void SetIsExtendToMergeStringers( bool bExtend );

        bool IsExtendToPreventRisersSittingUnderLandings() const;

        void SetIsExtendToPreventRisersSittingUnderLandings( bool bExtend );

        AECDefs::StairFlightLengthLimit GetMinFlightLimitType() const;

        void SetMinFlightLimitType( AECDefs::StairFlightLengthLimit eType );

        OdUInt16 GetMinFlightLimit() const;

        void SetMinFlightLimit( OdUInt16 iLimit );

        double GetMinFlightHeight() const;

        void SetMinFlightHeight( double dHeight );

        AECDefs::StairFlightLengthLimit GetMaxFlightLimitType() const;

        void SetMaxFlightLimitType( AECDefs::StairFlightLengthLimit eType );

        OdUInt16 GetMaxFlightLimit() const;

        void SetMaxFlightLimit( OdUInt16 iLimit );

        double GetMaxFlightHeight() const;

        void SetMaxFlightHeight( double dHeight );

        AECDefs::StairUShapedFlight GetExtendAlignmentOn() const;

        void SetExtendAlignmentOn( AECDefs::StairUShapedFlight eFlight );

        AECDefs::StairUShapedFlight GetUnevenTreadOn() const;

        void SetUnevenTreadOn( AECDefs::StairUShapedFlight eFlight );

        AECDefs::StairJustification GetJustification() const;

        void SetJustification( AECDefs::StairJustification eJustification );
 

        double GetRadius();

        double GetGraphicsPathOffset() const;

        void SetGraphicsPathOffset( double dOffset );

        OdDbObjectId GetWinderStyle() const;

        void SetWinderStyle( const OdDbObjectId& idWinderStyle );

        OdUInt32 GetTreadCount() const;

        double GetTreadAngleByIndex( OdUInt32 iIndex ) const;

        void SetTreadAngleByIndex(OdUInt32 iIndex, double dValue);

        AECStairCalculatorDataSubPtr GetCalculatorData() const;

        AECStairCreatorSubPtr GetStairCreator() const;

        OdUInt32 GetComponentCount() const;

        AECStairComponentSubPtr GetComponentByIndex( OdUInt32 iIndex ) const;

        AECImpArraySubPtr GetComponents() const;

        OdUInt32 GetSpanCount() const;

        AECStairFlightSpanSubPtr GetSpanByIndex( OdUInt32 iIndex ) const;

        AECImpArraySubPtr GetInterferences() const;

        AECImpArraySubPtr GetBodyModifiers() const;

        void SetWidth( double dWidth );

         double GetWidth() const;

        void Regenerate( bool bComplete = false );
 
    // Smart methods.
    public:
        void GetBaselineContour( FacetModeler::Contour2D& rResult,
            double dOffset = 0 ) const;

        void GetCompBaselineContour( OdUInt32 iIndex, FacetModeler::Contour2D& rResult,
            double dOffset = 0 ) const;

        void GetLeftSideContour( FacetModeler::Contour2D& rResult,
            double dOffset = 0 ) const;

        void GetCompLeftSideContour( OdUInt32 iIndex, FacetModeler::Contour2D& rResult,
            double dOffset = 0 ) const;

        void GetRightSideContour( FacetModeler::Contour2D& rResult,
            double dOffset = 0 ) const;

        void GetCompRightSideContour( OdUInt32 iIndex, FacetModeler::Contour2D& rResult,
            double dOffset = 0 ) const;
 
    public:
        static AECDbStairPtr CreateAECObject( const OdDbObjectId& idBlock,
            const OdDbObjectId& idStairStyle );

        static AECDbStairPtr CreateStraight( const OdDbObjectId& idBlock,
            const OdDbObjectId& idStairStyle, double dHeight, double dWidth );

        static AECDbStairPtr CreateMulti( const OdDbObjectId& idBlock,
            const OdDbObjectId& idStairStyle, double dHeight, double dWidth,
            AECDefs::StairCreatorPointType eType, const FacetModeler::Contour2D& rBaseline );

        static AECDbStairPtr CreateSpiral( const OdDbObjectId& idBlock,
            const OdDbObjectId& idStairStyle, double dHeight, double dWidth,
            const OdGeVector2d& vRefVector, double dRadius, bool bClockwise = false );

        static AECDbStairPtr CreateUShaped( const OdDbObjectId& idBlock,
            const OdDbObjectId& idStairStyle, double dHeight, double dWidth,
            const OdGePoint2d& ptStart, const OdGePoint2d& ptEnd,
            AECDefs::StairCreatorPointType eType, bool bClockwise = false );
};
 
#endif // __AECDBSTAIR_H__