AECCustomRailingRepresentation.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 __AECCUSTOMRAILINGREPRESENTATION_H__
#define __AECCUSTOMRAILINGREPRESENTATION_H__
 
#include "Subobjects/DispComps/AECDispCompEnt.h"
 
class AECARCHBASE_API AECCustomRailingRepresentation : public AECDispCompEnt
{
    AEC_DECLARE_MEMBERS( AECCustomRailingRepresentation );
 
    public:
        enum AttachTo
        {
            eAll        = 0,
            eFirst      = 1,
            eLast       = 2,
            eSelection  = 3,
        };
 
        enum XPosition
        {
            eXCenter        = 0,
            eXLeft          = 1,
            eXRight         = 2,
        };
 
        enum YPosition
        {
            eYCenter        = 0,
            eYFront         = 1,
            eYBack          = 2,
        };
 
        enum ZPosition
        {
            eZBottom        = 0,
            eZMiddle        = 1,
            eZTop           = 2,
        };
 
    public:
        bool IsScaleToFitWidth() const;
 
        void SetIsScaleToFitWidth( bool bScale );
 
        bool IsScaleToFitDepth() const;
 
        void SetIsScaleToFitDepth( bool bScale );
 
        bool IsScaleToFitLockXYRatio() const;
 
        void SetIsScaleToFitLockXYRatio( bool bScale );
 
        bool IsBetweenComps() const;
 
        void SetIsBetweenComps( bool bBetween );
 
        XPosition GetXPosition() const;
 
        void SetXPosition( XPosition ePosition );
 
        YPosition GetYPosition() const;
 
        void SetYPosition( YPosition ePosition );
 
        bool IsMirrorX() const;
 
        void SetIsMirrorX( bool bMirror );
 
        bool IsMirrorY() const;
 
        void SetIsMirrorY( bool bMirror );
 
        bool IsReplace() const;
 
        void SetIsReplace( bool bReplace );
 
        bool IsHandrailComponent() const;
 
        void SetIsHandrailComponent( bool bOn );
 
        bool IsGuardrailComponent() const;
 
        void SetIsGuardrailComponent( bool bOn );
 
        bool IsBottomrailComponent() const;
 
        void SetIsBottomrailComponent( bool bOn );
 
        bool IsFixedPostComponent() const;
 
        void SetIsFixedPostComponent( bool bOn );
 
        bool IsDynamicPostComponent() const;
 
        void SetIsDynamicPostComponent( bool bOn );
 
        bool IsBalusterComponent() const;
 
        void SetIsBalusterComponent( bool bOn );
 
        AttachTo GetAttachTo() const;
 
        void SetAttachTo( AttachTo eType );
 
        OdUInt16 GetSelectionStart() const;
 
        void SetSelectionStart( OdUInt16 iIndex );
 
        OdUInt16 GetSelectionEnd() const;
 
        void SetSelectionEnd( OdUInt16 iIndex );
 
        double GetZRotation() const;
 
        void SetZRotation( double dRotation );
 
    public:
        bool IsSkippedComponent( OdUInt32 iOverall, OdUInt32 iIndex ) const;
        bool IsDrawnForComponent( OdUInt32 iOverall, OdUInt32 iIndex ) const;
 
    protected:
        // This union represents internal structure of 32-bit flag containter.
        //
        // o m_iScaleDepth, m_iScaleWidth and m_iScaleHeight indicate if custom block should be scaled to fit certain dimension.
        // o m_iLockRatio indicates whether scaling ratio should be locked. It is disabled if only one flag is selected. Lock ratio disables other scaling parameters and between comp parameter.
        // o m_iBetweenComp is enabled only if block is attached to baluster or any post. Between comp disables scale to fit depth and enables lock ratio.
        // o m_iXAnchor has the following values: 1 for "left", 0 for "center", 2 for "right"
        // o m_iYAnchor has the following values: 1 for "front", 0 for "center", 2 for "back"
        // o m_iZAnchor has the following values: 0 for "bottom", 1 for "middle", 2 for "top"
        // o m_iMirrorX, m_iMirrorY and m_iMirrorZ have boolean-like behaviour
        // o m_iAlignSlope enables m_iShear and m_iUseOrigin
        // o m_iShear disables m_iUseOrigin
        // o m_iUseOrigin does not affect anything
        // o m_iReplace indicates if selected custom block should replace selected components
        //
        union GeometryFlags
        {
            OdUInt32            m_iFlags;
            struct
            {
#ifdef ODA_BIGENDIAN
                OdUInt32        m_iReserved     :14;
                OdUInt32        m_iReplace      : 1;
                OdUInt32        m_iUseOrigin    : 1;
                OdUInt32        m_iShear        : 1;
                OdUInt32        m_iAlignSlope   : 1;
                OdUInt32        m_iMirrorZ      : 1;
                OdUInt32        m_iMirrorY      : 1;
                OdUInt32        m_iMirrorX      : 1;
                OdUInt32        m_iZAnchor      : 2;
                OdUInt32        m_iYAnchor      : 2;
                OdUInt32        m_iXAnchor      : 2;
                OdUInt32        m_iBetweenComps : 1;
                OdUInt32        m_iLockRatio    : 1;
                OdUInt32        m_iScaleHeight  : 1;
                OdUInt32        m_iScaleWidth   : 1;
                OdUInt32        m_iScaleDepth   : 1;
#else
                OdUInt32        m_iScaleDepth   : 1;
                OdUInt32        m_iScaleWidth   : 1;
                OdUInt32        m_iScaleHeight  : 1;
                OdUInt32        m_iLockRatio    : 1;
                OdUInt32        m_iBetweenComps : 1;
                OdUInt32        m_iXAnchor      : 2;
                OdUInt32        m_iYAnchor      : 2;
                OdUInt32        m_iZAnchor      : 2;
                OdUInt32        m_iMirrorX      : 1;
                OdUInt32        m_iMirrorY      : 1;
                OdUInt32        m_iMirrorZ      : 1;
                OdUInt32        m_iAlignSlope   : 1;
                OdUInt32        m_iShear        : 1;
                OdUInt32        m_iUseOrigin    : 1;
                OdUInt32        m_iReplace      : 1;
                OdUInt32        m_iReserved     :14;
#endif
            }                   m_bBits;
        };
 
        // This union represents internal structure of 16-bit flag container. Theese
        // flags define railing components custom block is attached to. Custom block can
        // be attached only to one type components: either to railings or to posts and balusters.
        union ComponentFlags
        {
            OdUInt16            m_iFlags;
            struct
            {
#ifdef ODA_BIGENDIAN
                OdUInt16        m_iReserved     :10;
                OdUInt16        m_iBaluster     : 1;
                OdUInt16        m_iDynamicPost  : 1;
                OdUInt16        m_iMainPost     : 1;
                OdUInt16        m_iBottomrail   : 1;
                OdUInt16        m_iGuardrail    : 1;
                OdUInt16        m_iHandrail     : 1;
#else
                OdUInt16        m_iHandrail     : 1;
                OdUInt16        m_iGuardrail    : 1;
                OdUInt16        m_iBottomrail   : 1;
                OdUInt16        m_iMainPost     : 1;
                OdUInt16        m_iDynamicPost  : 1;
                OdUInt16        m_iBaluster     : 1;
                OdUInt16        m_iReserved     :10;
#endif
            }                   m_bBits;
        };
 
    protected:
        // This value stores general flags.
        GeometryFlags m_uGeometryFlags;
 
        // Guess: this value should store position.
        ComponentFlags m_uComponentFlags;
 
        // This is enum-like value, that stores "attach to" setting.
        // In DXF stream it is stored as 16-bit integer.
        AttachTo m_eAttachTo;
 
        // This is selection start for an appropriate "attach to" value.
        OdUInt16 m_iSelectionStart;
 
        // This is selection end for an appropriate "attach to" value.
        OdUInt16 m_iSelectionEnd;
 
        // This value stores rotate-z angle.
        double m_dRotateZ;
};
 
typedef OdSmartPtr<AECCustomRailingRepresentation> AECCustomRailingRepresentationPtr;
typedef AECSubPtr<AECCustomRailingRepresentation> AECCustomRailingRepresentationSubPtr;
 
#endif // __AECCUSTOMRAILINGREPRESENTATION_H__