///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, 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-2025 by Open Design Alliance.
// All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
// This file is generated automatically.
#ifndef _IFC2X_FINAL_IFCSHAPEREPRESENTATION_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCSHAPEREPRESENTATION_AUTO_IMPL_H
#include "IfcRepresentationAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC2X_FINAL express schema definitions.
*/
namespace OdIfc2x_final {
/** \details
The IfcShapeRepresentation represents the concept of a particular geometric representation
of a product or a product component within a specific geometric representation context.
The inherited attribute RepresentationType is used to define the geometric model used
for the shape representation (e.g. 'SweptSolid', or 'Brep'), the inherited attribute RepresentationIdentifier
is used to denote the kind of the representation captured by the IfcShapeRepresentation (e.g. 'Axis', 'Body', etc.).
Several representation identifiers for shape representation are included as predefined values for RepresentationIdentifier.
Table below indicates the defined list of values for RepresentationIdentifier.
Identifier Description
CoG Point to identify the center of gravity of an element. This value can be used for validation purposes
Box Bounding box as simplified 3D box geometry of an element
Annotation 3D annotations not representing elements
Axis 2D or 3D Axis, or single line, representation of an element
FootPrint 2D Foot print, or double line, representation of an element, projected to ground view
Profile 3D line representation of a profile being planar, e.g. used for door and window outlines
Surface 3D Surface representation, e.g. of an analytical surface, of an element plane)
Reference 3D representation that is not part of the Body representation. This is used, e.g., for opening geometries, if there are to be excluded from an implicit Boolean operation
Body 3D Body representation, e.g. as wireframe, surface, or solid model, of an element
Body-FallBack 3D Body representation, e.g. as tessellation, or other surface, or boundary representation, added in addition to the solid model (potentially involving Boolean operations) of an element
Clearance 3D clearance volume of the element. Such clearance region indicates space that should not intersect with the 'Body' representation of other elements, though can intersect with the 'Clearance' representation of other elements
Lighting Representation of emitting light as a light source within a shape representation
Several representation types for shape representation are included as predefined values for RepresentationType.
Table below indicates the defined list of values for RepresentationType.
Type Description
Point 2 or 3 dimensional point(s)
PointCloud 3 dimensional points represented by a point list
Curve 2 or 3 dimensional curve(s)
Curve2D 2 dimensional curve(s)
Curve3D 3 dimensional curve(s)
Surface 2 or 3 dimensional surface(s)
Surface2D 2 dimensional surface(s) (a region on ground view)
Surface3D 3 dimensional surface(s)
SectionedSurface Swept surface(s) created by sweeping open profiles along a directrix
FillArea 2D region(s) represented as a filled area (hatching)
Text Text defined as text literals
AdvancedSurface 3 dimensional b-spline surface(s)
GeometricSet Points, curves, surfaces (2 or 3 dimensional)
GeometricCurveSet Points, curves (2 or 3 dimensional)
Annotation2D Points, curves (2 or 3 dimensional), hatches and text (2 dimensional)
SurfaceModel Face based and shell based surface model(s), or tessellated surface model(s)
Tessellation Tessellated surface representation(s) only
Segment Partial geometry of curves that is not rendered separately from the main curve
SolidModel Including swept solid, Boolean results and Brep bodies;
SweptSolid Swept area solids, by extrusion and revolution, excluding tapered sweeps
AdvancedSweptSolid Swept area solids created by sweeping a profile along a directrix, and tapered sweeps
Brep Faceted Brep's with and without voids
AdvancedBrep Brep's based on advanced faces, with b-spline surface geometry, with and without voids
CSG Boolean results of operations between solid models, half spaces and Boolean results
Clipping Boolean differences between swept area solids, half spaces and Boolean results
BoundingBox Simplistic 3D representation by a bounding box
SectionedSpine Cross-section-based representation of a spine curve and planar cross sections. It can represent a surface or a solid and the interpolations of the between the cross sections is not defined
LightSource Light source with (depending on type) position, orientation, light colour, intensity and attenuation
MappedRepresentation Representation based on mapped item(s), referring to a representation map
*/
class IFC2X_FINAL_EXPORT IfcShapeRepresentation : public IfcRepresentation
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcShapeRepresentation);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of OfShapeAspect attribute.
This attribute represents reference to the shape aspect, for which it is the shape representation.
\param OfShapeAspect [out] Receives the value of OfShapeAspect attribute.
*/
void getInvOfShapeAspect(OdDAIObjectIds& OfShapeAspect) const;
public:
/** \details
Reads object's data from the specified filer.
\param rdFiler [in] Pointer to a filer from which to read the data.
\returns
A value of OdResult type that contains the result of the method execution.
*/
virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;
/** \details
Writes object's data the the specified filer.
\param wrFiler [in] Pointer to a filer to which to write the data.
\returns
A value of OdResult type that contains the result of the method execution.
*/
virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;
/** \details
Returns a type of a class instance.
\returns
Pointer to the OdDAI::Entity type that determines an entity definition within a schema.
*/
virtual OdDAI::Entity* getInstanceType() const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrName [in] Explicit name of the attribute to reset.
*/
virtual void unsetAttr(const char * explicitAttrName) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrName [in] Explicit name of the attribute to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const char * explicitAttrName) const override;
/** \details
Checks whether the specified instance is the object derived from or belongs to this class.
\param entityType [in] Entity to check.
\returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.
*/
virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;
/** \details
Returns the type of this entity.
\returns
A value of the OdIfc::OdIfcEntityType type that represents type of this entity.
*/
virtual OdIfc::OdIfcEntityType type() const override;
/** \details
Returns an attribute value for the specified attribute definition.
\param attrDef [in] Attribute definition to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
*/
virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrDef [in] Attribute definition to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrDef [in] Explicit attribute definition to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;
protected:
using IfcRepresentation::getAttr;
using IfcRepresentation::putAttr;
protected:
// Declare friend classes for inverse attributes functionality:
friend class IfcShapeAspect;
};
/** \details
A data type that represents a smart pointer to a IfcShapeRepresentation object.
*/
typedef OdSmartPtr IfcShapeRepresentationPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCSHAPEREPRESENTATION_AUTO_IMPL_H