AECDbRailing.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 __AECDBRAILING_H__
#define __AECDBRAILING_H__
 
#include "AECArchBaseDefs.h"
#include "DbEntity/AECDbGeo.h"
#include "Subobjects/Railing/AECBaluster.h"
#include "Subobjects/Railing/AECRailing.h"
#include "Subobjects/Railing/AECRailingPost.h"
#include "Subobjects/Railing/AECRailingLowerProfile.h"
#include "Subobjects/Railing/AECImpRailingPostDef.h"
 
typedef OdSmartPtr<class AECDbRailing> AECDbRailingPtr;
 
class AECARCHBASE_API AECDbRailing : public AECDbGeo 
{
    AEC_DECLARE_MEMBERS( AECDbRailing );
 
    public:
        AECRailingLowerProfileSubPtr GetLowerProfile() const;
 
        AECRailingLowerProfileSubPtr GetBalusterProfile() const;
 
        OdUInt32 GetPostCount() const;
 
        AECImpRailingPostDefSubPtr GetPostByIndex( OdUInt32 iIndex ) const;
 
        // Returns the array of fixed posts.
        AECImpArraySubPtr GetPosts() const;
 
        bool IsGuardrailPresent() const;
 
        void SetIsGuardrailPresent( bool bPresent );
 
        bool IsHandrailPresent() const;
 
        void SetIsHandrailPresent( bool bPresent );
 
        bool IsBottomrailPresent() const;
 
        void SetIsBottomrailPresent( bool bPresent );
 
        bool IsFixedPostsPresent() const;
 
        void SetIsFixedPostsPresent( bool bPresent );
 
        bool IsDynamicPostsPresent() const;
 
        void SetIsDynamicPostsPresent( bool bPresent );
 
        bool IsBalustersPresent() const;
 
        void SetIsBalustersPresent( bool bPresent );
 
        bool IsFixedPostsAtCornersPresent() const;
 
        void SetIsFixedPostsAtCornersPresent( bool bPresent );
 
        bool IsOverrideStairTreadLength() const;
 
        void SetIsOverrideStairTreadLength( bool bOverride );
 
        double GetGuardrailHorizontalHeight() const;
 
        void SetGuardrailHorizontalHeight( double dHeight );
 
        double GetGuardrailSlopingHeight() const;
 
        void SetGuardrailSlopingHeight( double dHeight );
 
        double GetGuardrailOffsetFromPost() const;
 
        void SetGuardrailOffsetFromPost( double dOffset );
 
        AECDefs::RailingOffsetSide GetGuardrailOffsetSide() const;
 
        void SetGuardrailOffsetSide( AECDefs::RailingOffsetSide eSide );
 
        double GetHandrailHorizontalHeight() const;
 
        void SetHandrailHorizontalHeight( double dHeight );
 
        double GetHandrailSlopingHeight() const;
 
        void SetHandrailSlopingHeight( double dHeight );
 
        double GetHandrailOffsetFromPost() const;
 
        void SetHandrailOffsetFromPost( double dOffset );
 
        AECDefs::RailingOffsetSide GetHandrailOffsetSide() const;
 
        void SetHandrailOffsetSide( AECDefs::RailingOffsetSide eSide );
 
        double GetBottomrailHorizontalHeight() const;
 
        void SetBottomrailHorizontalHeight( double dHeight );
 
        double GetBottomrailSlopingHeight() const;
 
        void SetBottomrailSlopingHeight( double dHeight );
 
        double GetBottomrailOffsetFromPost() const;
 
        void SetBottomrailOffsetFromPost( double dOffset );
 
        AECDefs::RailingOffsetSide GetBottomrailOffsetSide() const;
 
        void SetBottomrailOffsetSide( AECDefs::RailingOffsetSide eSide );
 
        double GetBottomrailSpacing() const;
 
        void SetBottomrailSpacing( double dSpacing );
 
        OdUInt16 GetBottomrailCount() const;
 
        void SetBottomrailCount( OdUInt16 iCount );
 
        double GetDynamicPostsMaxDistance() const;
 
        void SetDynamicPostsMaxDistance( double dDistance );
 
        double GetBalustersMaxDistance() const;
 
        void SetBalustersMaxDistance( double dDistance );
 
        OdUInt16 GetBalustersPerTread() const;
 
        void SetBalustersPerTread( OdUInt16 iBaluster );
 
        AECRailingSubPtr GetHandrail() const;
 
        AECRailingSubPtr GetGuardrail() const;
 
        AECRailingSubPtr GetBottomrail() const;
 
        AECBalusterSubPtr GetBaluster() const;
 
        AECRailingPostSubPtr GetFixedPost() const;
 
        AECRailingPostSubPtr GetFirstFixedPost() const;
 
        AECRailingPostSubPtr GetLastFixedPost() const;
 
        AECRailingPostSubPtr GetDynamicPost() const;
 
        double GetTopExtension() const;
 
        double GetBottomExtension() const;
 
        double GetGuardrailEntireTopExtension() const;
 
        void SetGuardrailEntireTopExtension( double dExtension );
 
        double GetGuardrailEntireBottomExtension() const;
 
        void SetGuardrailEntireBottomExtension( double dExtension );
 
        double GetGuardrailFlightTopExtension() const;
 
        void SetGuardrailFlightTopExtension( double dExtension );
 
        double GetGuardrailFlightBottomExtension() const;
 
        void SetGuardrailFlightBottomExtension( double dExtension );
 
        double GetHandrailEntireTopExtension() const;
 
        void SetHandrailEntireTopExtension( double dExtension );
 
        double GetHandrailEntireBottomExtension() const;
 
        void SetHandrailEntireBottomExtension( double dExtension );
 
        double GetHandrailFlightTopExtension() const;
 
        void SetHandrailFlightTopExtension( double dExtension );
 
        double GetHandrailFlightBottomExtension() const;
 
        void SetHandrailFlightBottomExtension( double dExtension );
 
        bool IsAddToGuardrailEntireTopExtension() const;
 
        void SetIsAddToGuardrailEntireTopExtension( bool bAdd );
 
        bool IsAddToGuardrailEntireBottomExtension() const;
 
        void SetIsAddToGuardrailEntireBottomExtension( bool bAdd );
 
        bool IsAddToGuardrailFlightTopExtension() const;
 
        void SetIsAddToGuardrailFlightTopExtension( bool bAdd );
 
        bool IsAddToGuardrailFlightBottomExtension() const;
 
        void SetIsAddToGuardrailFlightBottomExtension( bool bAdd );
 
        bool IsAddToHandrailEntireTopExtension() const;
 
        void SetIsAddToHandrailEntireTopExtension( bool bAdd );
 
        bool IsAddToHandrailEntireBottomExtension() const;
 
        void SetIsAddToHandrailEntireBottomExtension( bool bAdd );
 
        bool IsAddToHandrailFlightTopExtension() const;
 
        void SetIsAddToHandrailFlightTopExtension( bool bAdd );
 
        bool IsAddToHandrailFlightBottomExtension() const;
 
        void SetIsAddToHandrailFlightBottomExtension( bool bAdd );
 
        bool IsUseStairLandingExtensionsAtFloors() const;
 
        void SetIsUseStairLandingExtensionsAtFloors( bool bUse );
 
        bool IsUseStairLandingExtensionsAtFlights() const;
 
        void SetIsUseStairLandingExtensionsAtFlights( bool bUse );
 
    public:
        void AttachStairAnchor( const OdDbObjectId& idStair );
 
        double GetRailOffset( double dInitialOffset,
            AECDefs::RailingOffsetSide eSide ) const;
 
        void GetPostLocations( std::vector<double>& aLocations ) const;
 
        void GetFixedPostLocations( std::vector<double>& aLocations,
            bool bIncludeHidden = false ) const;
 
        void GetDynamicPostLocations( std::vector<double>& aLocations ) const;
 
        void GetBalusterLocations( std::vector<double>& aLocations ) const;
 
        void RedistributePosts();
 
        bool Reverse();
 
    public:
        static AECDbRailingPtr CreateAECObject( const OdDbObjectId& idBlock,
            const OdDbObjectId& idRailingStyle );
};
 
#endif  //__AECDBRAILING_H__