DbPointCloudEx.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 _OD_DB_POINTCLOUDEX_
#define _OD_DB_POINTCLOUDEX_
 
#include "DbPointCloudObjExports.h"
#include "DbPointCloudCropping.h"
#include "DbPointCloudIntensityStyle.h"
#include "TD_PackPush.h"
 
#include "DbEntity.h"
 
class DBPOINTCLOUDOBJ_EXPORT OdDbPointCloudEx : public OdDbEntity
{
public:
 
  //DOM-IGNORE-BEGIN
  ODDB_DECLARE_MEMBERS( OdDbPointCloudEx );
  //DOM-IGNORE-END
 
  OdDbPointCloudEx();
 
  ~OdDbPointCloudEx() {}
 
  OdDbObjectId pointCloudDefExId() const;
 
  void setPointCloudDefExId( const OdDbObjectId pointCloudDefExId );  
 
  OdDbObjectId reactorId() const;
 
  void setReactorId( const OdDbObjectId pointCloudDefReactorExId );
 
  bool locked() const;
 
  void setLocked( bool bLocked );
 
  double scale() const;
 
  void setScale( double scale );
 
  double rotation() const;
 
  void setRotation( double newRotation );
 
  OdGePoint3d location() const;
 
  void setLocation( OdGePoint3d newLocation );
 
  void getNativeCloudExtent( OdGeExtents3d& extents ) const;
 
  unsigned int getVisiblePointCount( OdGeExtents3d extents );
 
  unsigned int getLoadedVisiblePointCount( OdGeExtents3d extents );
 
  unsigned int getDisplayedVisiblePointCount( OdGeExtents3d extents );
 
  bool getActiveFileName( OdString& fileName ) const;
 
  bool setActiveFileName( const OdChar* strActiveFileName );
 
  OdString getPointCloudName() const;
 
  OdResult setPointCloudName( const OdString& name );
 
  //
 
  OdDbPointCloudCropping* getConstPointCloudCropping( int index );
 
  OdDbPointCloudCropping const* getConstPointCloudCropping( int index ) const;
 
  void addCroppingBoundary( OdDbPointCloudCropping const &boundary );
 
  OdResult clearCropping();
 
  OdResult removeLastCropping();
 
  OdUInt32 getCroppingCount() const;
 
  bool getCroppingInvert() const;
 
  OdResult setCroppingInvert( bool bInvert );
 
  OdResult setInCreatingCroppingMode( bool bCreating );
 
  bool showCropping() const;
 
  OdResult setShowCropping( bool bShowCropping );
 
  //
  enum StylizationType
  {
    kTrueColor = 1,
    kSingleColor,
    kNormalRamp,
    kHeightRamp,
    kIntensityRamp,
    kClassificationRamp
  };
 
  StylizationType stylizationType() const;
 
  OdResult setStylizationType( StylizationType type );
 
  //
 
  OdString getCurrentColorScheme() const;
 
  OdResult setCurrentColorScheme( const OdString &guid );
 
  OdString getColorSchemeForStylization( StylizationType type ) const;
 
  OdResult setColorSchemeForStylization( const OdString &guid, StylizationType type );
 
  //
 
  enum DisplayOptionOutOfRange
  {
    kUseMinMaxColors = 0,
    kUseRGBScanColors,
    kHidePoints
  };
 
  bool showIntensityAsGradient() const;
 
  void setShowIntensityAsGradient( bool bShowAsGradient );
 
  OdInt32 minIntensity() const;
 
  OdInt32 maxIntensity() const;
 
  OdResult setMinMaxIntensity( OdInt32 min, OdInt32 max );
 
  DisplayOptionOutOfRange intensityOutOfRangeBehavior() const;
 
  void setIntensityOutOfRangeBehavior( DisplayOptionOutOfRange displayOption );
 
  bool showElevationAsGradient() const;
 
  void setShowElevationAsGradient( bool bShowAsGradient );
 
  double minElevation() const;
 
  double maxElevation() const;
 
  OdResult setMinMaxElevation( double min, double max );
 
  bool elevationApplyToFixedRange() const;
 
  void setElevationApplyToFixedRange( bool bFixedRange );
 
  DisplayOptionOutOfRange elevationOutOfRangeBehavior() const;
 
  void setElevationOutOfRangeBehavior( DisplayOptionOutOfRange displayOption );
 
 
  OdResult subTransformBy( const OdGeMatrix3d& xform );
 
  bool subWorldDraw( OdGiWorldDraw* pWd ) const;
 
  void subViewportDraw( OdGiViewportDraw* pVd ) const;
 
  virtual OdResult subGetGeomExtents(OdGeExtents3d& extents) const;
 
  // File IO
 
  virtual OdResult  dwgInFields( OdDbDwgFiler *pFiler);
 
  virtual void  dwgOutFields( OdDbDwgFiler *pFiler) const;
 
  virtual OdResult  dxfInFields( OdDbDxfFiler *pFiler);
 
  virtual void  dxfOutFields( OdDbDxfFiler *pFiler) const;
 
  virtual void subClose();
 
};
 
typedef OdSmartPtr<OdDbPointCloudEx> OdDbPointCloudExPtr;
 
DBPOINTCLOUDOBJ_EXPORT OdResult oddbCreatePointCloudExEntity(
  OdDbBlockTableRecord* pBlockToAdd,
  OdDbPointCloudExPtr& newPointCloud,  
  const OdString& sourceFile,
  const OdGePoint3d& location = OdGePoint3d::kOrigin,
  double             scale = 1.0,
  double             rotation = 0.0,
  const OdGeVector3d& vAxis = OdGeVector3d::kZAxis
);
 
#include "TD_PackPop.h"
 
 
#endif //_OD_DB_POINTCLOUDEX_