IfcModelFiller.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 _IFC_MODEL_FILLER_H
#define _IFC_MODEL_FILLER_H
 
#include "OdPlatformSettings.h"
#include "Ge/GePlane.h"
 
#include "IfcModel.h"
#include "IfcEntity.h"
#include "IfcSimpleTypes.h"
#include "IfcPropertySetFiller.h"
#include "IfcQuantitySetFiller.h"

class IFCCORE_EXPORT OdIfcModelFiller
{
public:

  enum UnitsConversion {
    IfcLengthUnit_Inch_To_Meters = 0,
    IfcLengthUnit_Foot_To_Meters = 1,
    IfcAreaUnit_SquareInch_To_SquareMeters = 7,
    IfcAreaUnit_SquareFoot_To_SquareMeters = 8,
    IfcVolumeUnit_CubicInch_To_CubicMeters = 15,
    IfcVolumeUnit_CubicFoot_To_CubicMeters = 16,
    IfcPlaneAngleUnit_Angle_To_Radians = 23
  };
 
protected:
 
  struct EntityDefinitions
  {
    const OdDAI::Entity* IfcAlignment;
    const OdDAI::Entity* IfcAxis2Placement2D;
    const OdDAI::Entity* IfcAxis2Placement3D;
    const OdDAI::Entity* IfcBridge;
    const OdDAI::Entity* IfcBuilding;
    const OdDAI::Entity* IfcCartesianPoint;
    const OdDAI::Entity* IfcDirection;
    const OdDAI::Entity* IfcOwnerHistory;
    const OdDAI::Entity* IfcProduct;
    const OdDAI::Entity* IfcProject;
    const OdDAI::Entity* IfcRailway;
    const OdDAI::Entity* IfcRoot;
    const OdDAI::Entity* IfcSite;
    const OdDAI::Entity* IfcSiUnit;
    const OdDAI::Entity* IfcUnitAssignment;
    const OdDAI::Entity* IfcConversionBasedUnit;
    const OdDAI::Entity* IfcMeasureWithUnit;
 
  };
  EntityDefinitions Entity;
  void initEntities();
 
protected:
 
  OdIfcModelPtr m_model;
 
  OdIfcModelFiller(OdDAI::Model *model)
    : m_model(model)
  {
    initEntities();
 
    m_objectDefinition = OdIfc::OdIfcInstancePtr();
    m_propertySet = OdIfc::OdIfcInstancePtr();
  }
 
  OdIfc::OdIfcInstancePtr m_person;
  OdIfc::OdIfcInstancePtr m_ownerHistory;
  OdIfc::OdIfcInstancePtr m_unitAssignment;
  OdIfc::OdIfcInstancePtr m_project;
  OdIfc::OdIfcInstancePtr m_site;
 
  //
  // Common entities, must not be changed as their purposes are predefined:
  //
  OdDAIObjectId m_dirX;
  OdDAIObjectId m_dirY;
  OdDAIObjectId m_dirZ;
  OdDAIObjectId m_posOrigin;
  OdDAIObjectId m_identity;
 
  OdDAIObjectId m_dirX2D;
  OdDAIObjectId m_dirY2D;
  OdDAIObjectId m_posOrigin2D;
  OdDAIObjectId m_identity2D;
 
  OdDAIObjectIds  unitsCollection;
 
  std::map<OdIfc::OdIfcInstance*, OdIfc::OdIfcInstance*> m_relAggregates;
  std::map<OdIfc::OdIfcInstance*, OdIfc::OdIfcInstance*> m_relContainedInSpatialStructure;
  std::map<OdIfc::OdIfcInstance*, OdIfc::OdIfcInstance*> m_relReferencedInSpatialStructure;
  std::map<OdAnsiString, OdIfc::OdIfcInstance*> m_geometricRepresentationContext;
  std::map<OdAnsiString, std::map<OdAnsiString, OdIfc::OdIfcInstance*> > m_geometricRepresentationSubContext;
  std::map<OdIfc::OdIfcInstance*, OdIfc::OdIfcInstance*> m_relDefinesByProperties;
 
  std::map<OdAnsiString, OdIfc::OdIfcInstance*> m_surfaceStyles;
 
  OdIfc::OdIfcInstancePtr m_objectDefinition;
  OdIfc::OdIfcInstancePtr m_propertySet;
 
  OdDAIObjectIds m_idProperties;
 
  std::map<UnitsConversion, double> m_conversionFactors;

  void appendSharedInstances();
 
public:

  virtual ~OdIfcModelFiller() {};

  OdIfcModelPtr model() { return m_model; };

  OdIfc::OdIfcInstancePtr createFromScratch(
    const OdString &organizationName,
    const OdString &applicationDeveloperName,
    const OdString &applicationDeveloperDescription,
    const OdString &applicationFullName,
    const OdString &applicationVersion,
    const OdString &applicationIdentifier
  );
 
  //
  // Common instances accessors
  //
  
  const OdDAIObjectId& dirX() const { return m_dirX; };
  
  const OdDAIObjectId& dirY() const  { return m_dirY; };
  
  const OdDAIObjectId& dirZ() const  { return m_dirZ; };
  
  const OdDAIObjectId& origin() const { return m_posOrigin; };
  const OdDAIObjectId& identity() const { return m_identity; };
  
  const OdDAIObjectId& dirX2D() const  { return m_dirX2D; };
  
  const OdDAIObjectId& dirY2D() const { return m_dirY2D; };
  
  const OdDAIObjectId& origin2D() const { return m_posOrigin2D; };
  const OdDAIObjectId& identity2D() const { return m_identity2D; };

  OdIfc::OdIfcInstancePtr person() { return m_person; };
  
  OdIfc::OdIfcInstancePtr ownerHistory() { return m_ownerHistory; };
  
  OdIfc::OdIfcInstancePtr unitAssignment() { return m_unitAssignment; };
  
  OdIfc::OdIfcInstancePtr project() { return m_project; };
  
  OdIfc::OdIfcInstancePtr site() { return m_site; };
 
  
  OdIfc::OdIfcInstancePtr getObjectDefinition() { return m_objectDefinition; };
  
  OdIfc::OdIfcInstancePtr getPropertySet() { return m_propertySet; };

  bool putAttrs(OdIfc::OdIfcInstancePtr &inst, std::map<OdAnsiString, OdRxValue>& attrs);
  
  void setOwnerHistory(OdIfc::OdIfcInstancePtr history) { if (!history.isNull()) m_ownerHistory = history; };

  void setProject(OdIfc::OdIfcInstancePtr project) { if (!project.isNull()) m_project = project; };

  bool appendId(OdIfc::OdIfcInstance* pInst, OdIfc::OdIfcAttribute attr, OdDAIObjectId id);

  OdIfc::OdIfcInstancePtr appendGeometricRepresentationContext(const OdAnsiString &name, const OdAnsiString &type, int dim, double precision = OdDAI::Consts::OdNan, OdDAIObjectId idWCS = OdDAIObjectId(), OdDAIObjectId idTrueNorth = OdDAIObjectId());

  OdIfc::OdIfcInstancePtr appendGeometricRepresentationSubContext(const OdAnsiString &contextIdentifier, const OdAnsiString &contextType, OdIfc::OdIfcInstancePtr pParent, OdAnsiString targetView);
  
  OdIfc::OdIfcInstancePtr getGeometricRepresentationContext(const OdAnsiString &type);

  OdIfc::OdIfcInstancePtr getGeometricRepresentationSubContext(const OdAnsiString &contextIdentifier, const OdAnsiString &contextType);

  OdIfc::OdIfcInstancePtr createShapeRepresentation(const OdDAIObjectId & contextOfItems, const OdAnsiString & representationIdentifier, const OdAnsiString & representationType, const OdDAIObjectIds & items);
  
  OdIfc::OdIfcInstancePtr createProductDefinitionShape(const OdDAIObjectIds & representations);

  OdIfc::OdIfcInstancePtr createRepresentationMap(const OdDAIObjectId & MappingOrigin, const OdDAIObjectId & MappedRepresentation);

  OdIfc::OdIfcInstancePtr createMappedItem(const OdDAIObjectId & MappingSource, const OdDAIObjectId & MappingTarget);

  OdIfc::OdIfcInstancePtr createCompositeCurve(const OdDAIObjectIds & segments, bool selfIntersect);

  OdIfc::OdIfcInstancePtr createCompositeCurveSegment(const OdAnsiString & transition, bool sameSense, const OdDAIObjectId & parentCurve);

  OdIfc::OdIfcInstancePtr createCurveStyle(const OdDAIObjectId & curveColourId);

  OdIfc::OdIfcInstancePtr createTrimmedCurve(const OdDAIObjectId& basisCurve, double param1, double param2, bool bSenseAgreement);

  OdIfc::OdIfcInstancePtr createTrimmedCurve(const OdDAIObjectId & basisCurve, const OdDAIObjectId & trim1, const OdDAIObjectId & trim2, bool bSenseAgreement);

  OdIfc::OdIfcInstancePtr createPolyline(const OdDAIObjectIds & points);

  OdIfc::OdIfcInstancePtr createCircle(const OdGePoint2d & center, const OdGeVector2d & refDirection, double radius);

  OdIfc::OdIfcInstancePtr createPlane(const OdDAIObjectId & position);

  OdIfc::OdIfcInstancePtr createPlane(const OdGePlane & plane);

  OdIfc::OdIfcInstancePtr createWallStandardCase(const OdString & name, const OdDAIObjectId & objectPlacement, const OdDAIObjectId & representation);

  OdIfc::OdIfcInstancePtr createWall(const OdString & name, const OdDAIObjectId & objectPlacement, const OdDAIObjectId & representation);

  OdIfc::OdIfcInstancePtr createSlab(const OdString & name,
    const OdDAIObjectId & objectPlacement,
    const OdDAIObjectId & representation,
    const OdAnsiString & predefinedType);

  OdIfc::OdIfcInstancePtr createOpening(const OdString& name,
    const OdDAIObjectId & objectPlacement,
    const OdDAIObjectId & representation,
    const OdAnsiString & predefinedType = OdAnsiString());

  OdIfc::OdIfcInstancePtr addRelVoidsElement(const OdDAIObjectId & relatingBuildingElement, const OdDAIObjectId & relatedOpeningElement);
  
  OdIfc::OdIfcInstancePtr createRelFillsElement(const OdDAIObjectId & relatingOpeningElement, const OdDAIObjectId & relatedBuildingElement);
  
  OdIfc::OdIfcInstancePtr createClassificationReference(const OdString & materialDefName, const OdString & location, const OdAnsiString & itemReference, const OdDAIObjectId & referencedSource);
  
  OdIfc::OdIfcInstancePtr createClassification(const OdAnsiString & source, const OdAnsiString & edition, const OdString & name);

  OdIfc::OdIfcInstancePtr createSiUnit(const char *unitType, const char *prefix, const char *name, bool append = false);
  
  OdIfc::OdIfcInstancePtr createUnitAssignment(const OdArray<OdDAIObjectId>& unitsCollection);

  OdIfc::OdIfcInstancePtr createConversionBasedUnit(const OdAnsiString & name, const OdDAIObjectId & conversionFactor, const OdDAIObjectId & dimensions, const OdAnsiString & unitType);

  OdIfc::OdIfcInstancePtr createMeasureWithUnit(double measureValue, const OdDAIObjectId& unit, const OdAnsiString& typeName);

  void setUnitAssignment(OdIfc::OdIfcInstancePtr unitsAssignment = OdIfc::OdIfcInstancePtr());

  OdIfc::OdIfcInstancePtr addRelAggregates(OdIfc::OdIfcInstancePtr pRelating, OdIfc::OdIfcInstancePtr pRelated);

  OdIfc::OdIfcInstancePtr appendRelAggregates(OdIfc::OdIfcInstancePtr pRelating, OdIfc::OdIfcInstancePtr pRelated);

  OdIfc::OdIfcInstancePtr getRelAggregates(OdIfc::OdIfcInstancePtr pRelating);
  
  OdIfc::OdIfcInstancePtr addRelContainedInSpatialStructure(OdIfc::OdIfcInstancePtr pRelating, OdIfc::OdIfcInstancePtr pRelated);

  OdIfc::OdIfcInstancePtr addRelReferencedInSpatialStructure(OdIfc::OdIfcInstancePtr pRelating, OdIfc::OdIfcInstancePtr pRelated);

  OdIfc::OdIfcInstancePtr createRelContainedInSpatialStructure(const OdDAIObjectIds & relatedElements, const OdDAIObjectId & relStructure);

  OdIfc::OdIfcInstancePtr createRelReferencedInSpatialStructure(const OdDAIObjectIds & relatedElements, const OdDAIObjectId & relStructure);

  OdIfc::OdIfcInstancePtr createRelAggregates(const OdString & name, const OdDAIObjectId & relatingObject, const OdDAIObjectIds & relatedObjects);

  OdIfc::OdIfcInstancePtr createColourRgb(const OdUInt8 & red, const OdUInt8 & green, const OdUInt8 & blue);

  OdIfc::OdIfcInstancePtr createColourRgb(const double & r, const double & g, const double & b);

  OdIfc::OdIfcInstancePtr createLocalPlacement(OdIfc::OdIfcInstancePtr placementRelTo, OdIfc::OdIfcInstancePtr relativePlacement);

  OdIfc::OdIfcInstancePtr createLocalPlacement3d(const OdDAIObjectId & placementRelTo, const OdDAIObjectId & relativePlacement);

  OdIfc::OdIfcInstancePtr createLocalPlacement3d(const OdDAIObjectId & placementRelTo, const OdGePoint3d & ptLocation, const OdGeVector3d & axis, const OdGeVector3d & refDirection);

  OdIfc::OdIfcInstancePtr createCartesianPoint(const OdGePoint3d &p);

  OdIfc::OdIfcInstancePtr createCartesianPoint(const OdGePoint2d &p);

  OdIfc::OdIfcInstancePtr createPointByDistanceExpression(double distanceAlong, const OdDAIObjectId& basisCurve, double offsetLateral = 0., double offsetVertical = 0., double offsetLongitudinal = 0., const OdAnsiString& distanceAlongType = "ifclengthmeasure");

  OdIfc::OdIfcInstancePtr createDirection(const OdGeVector3d &v);

  OdIfc::OdIfcInstancePtr createDirection(const OdGeVector2d &v);

  OdIfc::OdIfcInstancePtr createAxis2Placement3D(const OdGeMatrix3d &m);

  OdIfc::OdIfcInstancePtr createAxis2Placement3D(const OdDAIObjectId & location, const OdDAIObjectId & axis, const OdDAIObjectId & refDirection);

  OdIfc::OdIfcInstancePtr createAxis2Placement3D(const OdGePoint3d & ptLocation, const OdGeVector3d * axis, const OdGeVector3d * refDirection);

  OdIfc::OdIfcInstancePtr createAxis2Placement2D(const OdGeMatrix2d &m);

  OdIfc::OdIfcInstancePtr createAxis2Placement2D(const OdDAIObjectId & location, const OdDAIObjectId & refDirection);

  OdIfc::OdIfcInstancePtr createSite(const OdAnsiString& name = "Default site");

  double getConversionFactor(UnitsConversion unit) { return ((m_conversionFactors.find(unit) != m_conversionFactors.end()) ? m_conversionFactors.find(unit)->second : 1.); }

  IfcPropertySetFillerPtr initPropertySet(OdIfc::OdIfcInstancePtr objectDefinition);

  IfcPropertySetFillerPtr initDetachedPropertySet();

  OdIfc::OdIfcInstancePtr createIfcPropertySet(const OdString & name, const OdDAIObjectIds & props);

  IfcQuantitySetFillerPtr createQuantitySet(OdIfc::OdIfcInstancePtr objectDefinition);

  OdIfc::OdIfcInstancePtr createRelDefinesByProperties(const OdDAIObjectIds & relatedObjects, OdDAIObjectId & relatingPropDef);

  OdIfc::OdIfcInstancePtr appendRelDefinesByProperties(OdIfc::OdIfcInstancePtr pRelatingPropertyDefinition, OdIfc::OdIfcInstancePtr relatedObjectDefinition);
  
  OdIfc::OdIfcInstancePtr getRelDefinesByProperties(OdIfc::OdIfcInstancePtr pRelatingPropertyDefinition);

  OdIfc::OdIfcInstancePtr createRelDefinesByType(const OdDAIObjectIds & relatedOjects, const OdDAIObjectId & relTypeId);

  OdIfc::OdIfcInstancePtr createSurfaceStyle(const OdAnsiString &name, const OdCmEntityColor &color);

  OdIfc::OdIfcInstancePtr findSurfaceStyle(const OdAnsiString &name);

  OdIfc::OdIfcInstancePtr createStyledItem(OdIfc::OdIfcInstancePtr item, OdIfc::OdIfcInstancePtr style);

  OdIfc::OdIfcInstancePtr createVector(OdIfc::OdIfcInstancePtr pDirection, double magnitude);
 
  friend class OdIfcFile;
};

typedef OdSharedPtr<OdIfcModelFiller> OdIfcModelFillerPtr;
 
#endif // _IFC_MODEL_FILLER_H