Shape.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRTX_SHAPE_H_
#define PRTX_SHAPE_H_

#include "prtx/prtx.h"
#include "prtx/Attributable.h"
#include "prtx/Material.h"
#include "prtx/CGAError.h"
#include "prtx/TrimPlane.h"
#include "prtx/generated/BuiltinShapeAttributes.h"

#include <memory>

#ifdef _MSC_VER
#   pragma warning(push)
#   pragma warning (disable : 4251) // 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
#endif


namespace prtx {

class Geometry;
using GeometryPtr = std::shared_ptr<Geometry>;

class Shape;

typedef std::shared_ptr<Shape> ShapePtr;            
typedef std::vector<ShapePtr>  ShapePtrVector;      


class PRTX_EXPORTS_API Shape : public Attributable, public BuiltinShapeAttributes {
public:
    // --- prtx::Attributable

    // --- BuiltinShapeAttributes : all accessible through Attributable interface
    // with cga-name

    // --- non-cga shape attributes => simple types accessible through SPIIAttributable interface,
    // with "." prefix

    virtual uint32_t                       getID() const = 0;
    virtual uint32_t                       getParentID() const = 0;
    virtual GeometryPtr                    getGeometry() const = 0;
    virtual MaterialPtr                    getMaterial() const = 0;

    virtual const CGAErrorPtrVector&       getCGAErrors() const = 0;
    virtual const std::wstring&            getCGAPrint()  const = 0;

    // reporting
    typedef std::pair<StringPtr, bool>      ReportBool;
    typedef std::pair<StringPtr, double>    ReportFloat;
    typedef std::pair<StringPtr, StringPtr> ReportString;
    typedef std::vector<ReportBool>         ReportBoolVect;
    typedef std::vector<ReportFloat>        ReportFloatVect;
    typedef std::vector<ReportString>       ReportStringVect;

    virtual const ReportBoolVect&   getCGAReportsBool()   const = 0;
    virtual const ReportFloatVect&  getCGAReportsFloat()  const = 0;
    virtual const ReportStringVect& getCGAReportsString() const = 0;


    virtual int64_t                   getShapeSymbol() const = 0;
    virtual const TrimPlanePtrVector& getTrimPlanes()  const = 0;


protected:
    Shape() {}
    virtual ~Shape() {}
};


} // namespace prtx

#ifdef _MSC_VER
#   pragma warning(pop)
#endif


#endif /* SPI_SHAPE_H_ */