DXFAttributes.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: CAD
File: DXFAttributes
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "Base/Headers/String.h"
#include "Base/Headers/RGBColor.h"
 
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief DXF Style attributes that can be applied to CAD Entity objects.
    **/
    class DXFAttributes
    {
    public:
        DXFAttributes()
            : m_color(Constant<RGBColor>::Invalid)
            , m_line_type_scale(1.0)
            , m_width(0)
            , m_in_paper_space(false)
        {}
 
        DXFAttributes(const String& layer, const RGBColor& color, int width, String linetype, double linetypeScale)
            : m_layer(layer)
            , m_color(color)
            , m_line_type(std::move(linetype))
            , m_line_type_scale(linetypeScale)
            , m_width(width)
            , m_in_paper_space(false)
        {}
 
        DXFAttributes(String layer, const RGBColor& color, int width, String linetype, uint04 handle)
            : m_layer(std::move(layer))
            , m_color(color)
            , m_line_type(std::move(linetype))
            , m_line_type_scale(1.0)
            , m_handle(std::move(handle))
            , m_width(width)
            , m_in_paper_space(false)
        {}
 
        bool operator==(const DXFAttributes& attributes) const
        {
            return m_layer == attributes.m_layer
                && m_color == attributes.m_color
                && m_block == attributes.m_block
                && m_line_type == attributes.m_line_type
                && m_line_type_scale == attributes.m_line_type_scale
                && m_handle == attributes.m_handle
                && m_width == attributes.m_width
                && m_in_paper_space == attributes.m_in_paper_space;
        }
        bool operator!=(const DXFAttributes& attributes) const
        {
            return m_layer != attributes.m_layer
                || m_color != attributes.m_color
                || m_block != attributes.m_block
                || m_line_type != attributes.m_line_type
                || m_line_type_scale != attributes.m_line_type_scale
                || m_handle != attributes.m_handle
                || m_width != attributes.m_width
                || m_in_paper_space != attributes.m_in_paper_space;
        }
 
        void setLayer(const String& layer) { m_layer = layer; }
        [[nodiscard]] const String& getLayer() const { return m_layer; }
 
        void setBlock(const String& block) { m_block = block; }
        [[nodiscard]] const String& block() const { return m_block; }
 
        void setColor(const RGBColor& color) { m_color = color; }
 
        const RGBColor& getColor() const { return m_color; }
 
        void setWidth(int width) { m_width = width; }
 
        int getWidth() const { return m_width; }
 
        void setLinetype(const String& linetype) { m_line_type = linetype; }
 
        void setLinetypeScale(double linetypeScale) { m_line_type_scale = linetypeScale; }
 
        double getLinetypeScale() const { return m_line_type_scale; }
        const String& getLinetype() const
        {
            static const String by_layer("BYLAYER");
            return m_line_type.size() == 0 ? by_layer : m_line_type;
        }
 
        void setHandle(const String& h) { m_handle = h; }
        [[nodiscard]] const String& handle() const { return m_handle; }
 
        void setInPaperSpace(bool on) { m_in_paper_space = on; }
        bool isInPaperSpace() const { return m_in_paper_space; }
 
        void setSection(const String& h) { m_section = h; }
        const String& section() const { return m_section; }
 
    private:
        String m_section;
        String m_layer;
        String m_block;
        RGBColor m_color;
        String m_line_type;
        fltp08 m_line_type_scale;
        String m_handle;
        int m_width;
        // DXF code 67 (true: entity in paper space, false: entity in model space (default):
        bool m_in_paper_space;
    };
 
}