BrFace.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 _INC_DDBRFACE_3F82D5A203C8_INCLUDED
#define _INC_DDBRFACE_3F82D5A203C8_INCLUDED
 
#include "Br/BrEntity.h"
#include "Br/BrEnums.h"
#include "Ge/GeSurface.h"
#include "Ge/GeNurbSurface.h"
 
#include "TD_PackPush.h"
 
class OdCmEntityColor;
class OdGeExternalBoundedSurface;
class OdGeScale3d;

class ODBR_TOOLKIT_EXPORT OdBrFace : public OdBrEntity
{
public:

  OdBrErrorStatus getSurfaceAsNurb(OdGeNurbSurface& nurb) const;

  OdGeSurface* getSurface() const;

  OdBrErrorStatus getSurfaceType(OdGe::EntityId& surfaceType) const;

  OdBrErrorStatus        getArea(double& area,
    const double* tolRequired = NULL,
    double* tolAchieved = NULL) const;

  bool getOrientToSurface() const;
  bool getColor(OdCmEntityColor &color) const;

  bool getMaterialID(OdUInt64 &id) const;

  bool getMaterialString(OdString& strMatName) const;

 
  enum Projection
  {
    kInheritProjection  = 0, // Inherits *projection* from the current material's mapper.
    kPlanar             = 1, // Maps directly to XY coordinates.
    kBox                = 2, // Maps to planes perpendicular to major axes.
    kCylinder           = 3, // Maps to cylinder aligned with Z-axis.
    kSphere             = 4  // Maps to sphere aligned with Z-axis
  };
 
  enum Tiling
  {
    kInheritTiling    = 0, // Inherits *tiling* from the current material's mapper.
    kTile             = 1, // Repeats map along image axes.
    kCrop             = 2, // Crops map < 0.0 or > 1.0 on image axes.
    kClamp            = 3, // Clamps (stretches) map between 0.0 and 1.0 on image axes.
    kMirror           = 4  // Mirror the material map at every integer boundary.
  };
 
  enum AutoTransform
  {
    kInheritAutoTransform = 0x0, // Inherits automatic *transform* from the current material/s mapper.
    kNone                 = 0x1, // No automatic *transform*.
    kObject               = 0x2, // Adjusts the mapper *transform* to align with and fit the current object.
    kModel                = 0x4,  // Multiples the mapper *transform* by the current block *transform*.
 
    kPredefinedBim        = 0x8, // Uses predefined uv coordinates for mapping (BIM-specific case).
  };
 
  bool getMaterialMapper(OdGeMatrix3d &mx, Projection &projection, Tiling& tiling, AutoTransform &autoTransform) const;
 
  OdBrErrorStatus getSurfaceAsTrimmedNurbs(OdUInt32& numNurbs, OdGeExternalBoundedSurface**& ppNurbs) const;

  bool getFillPatternId(OdUInt64 &id) const;
  
  bool getFillingAttributes(bool isFaceForward, OdGePoint2d& origin, double& rotAngle, bool& swapUv, OdGeScale3d& scaleUv, double& uDerScale) const;

  bool getExtraFillingAttributes(OdGiFill* pFill) const;

  const OdGiFill* getFill() const;

  bool getFirstFaceRegion(OdBrFace& face) const;

  bool getNextFaceRegion(OdBrFace& face) const;

 
  bool getMaterialAttributes(OdGePoint2d& origin, double& angle) const;
 
  OdBrFace();
#ifdef OD_ADD_MOVE_CTOR_HAVE_DEF_DEL_FUNC
  //DOM-IGNORE-BEGIN
  OdBrFace(const OdBrFace&) = default;
  OdBrFace& operator=(const OdBrFace&) = default;
  OdBrFace(OdBrFace&&) = default;
  OdBrFace& operator=(OdBrFace&&) = default;
  //DOM-IGNORE-END
#endif
 
  ~OdBrFace();
};
 
#include "TD_PackPop.h"
 
#endif /* _INC_DDBRFACE_3F82D5A203C8_INCLUDED */