SSet.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 _SSET_H_
#define _SSET_H_
 
#include "OdPlatform.h"
 
#include "Ge/GePoint3d.h"
#include "DbBaseSubentId.h"
 
class ODRX_ABSTRACT FIRSTDLL_EXPORT OdDbSelectionMethod : public OdRxObject
{
protected:
  OdDbSelectionMethod();
public:
  ODRX_DECLARE_MEMBERS(OdDbSelectionMethod);
};
 
typedef OdSmartPtr<OdDbSelectionMethod> OdDbSelectionMethodPtr;
 
class OdGiViewport;
 
class FIRSTDLL_EXPORT OdDbVisualSelection : public OdDbSelectionMethod
{
protected:
  OdDbVisualSelection();
public:
  ODRX_DECLARE_MEMBERS(OdDbVisualSelection);
 
  enum Mode
  {
    kPoint        = 0, // Selection by single point. Returns single object: top for 3D render modes or first for 2D render mode.
    kBox          = 1, // Selection by two points (represents rectangle) and choose between kWindow and kCrossing modes using direction vector between points.
    kWindow       = 2, // Selection by two points (represents rectangle). Select only objects which is entirely inside selection area.
    kCrossing     = 3, // Selection by two points (represents rectangle). Select objects which is entirely inside or intersects selection area.
    kFence        = 4, // Selection by two or more points (represents polyline). Select object which is intersects selection polyline.
    kWPoly        = 5, // Selection by three or more points (represents polygon). Select only objects which is entirely inside selection area.
    kCPoly        = 6  // Selection by three or more points (represents polygon). Select objects which is entirely inside or intersects selection area.
  };
 
  enum SubentSelectionMode
  {
    kDisableSubents  = 0,
    kEnableSubents   = 1,
    // #CORE-13269 : include ModelSpace viewport into selection path.
    kIncludeViewport = 2,
    // #CORE-13761 : include nested entities even if them doesn't contain subentities (geometry markers).
    kNestedEntities  = 4
  };
 
  virtual OdDbStub* viewport() const = 0;
  virtual OdGePoint3dArray points() const = 0;
  virtual Mode mode() const = 0;
};
 
typedef OdSmartPtr<OdDbVisualSelection> OdDbVisualSelectionPtr;
 
 
class ODRX_ABSTRACT FIRSTDLL_EXPORT OdSelectionSetIterator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdSelectionSetIterator);
  
  virtual OdDbSelectionMethodPtr method() const = 0;
 
    virtual bool done() const = 0;
 
  virtual bool next() = 0;
 
  virtual OdUInt32 subentCount() = 0;
 
  virtual bool getSubentity(OdUInt32 i, OdDbBaseFullSubentPath& path) = 0;
 
  virtual OdDbStub* id() const = 0;
 
protected:
  OdSelectionSetIterator();
};
 
typedef OdSmartPtr<OdSelectionSetIterator>  OdSelectionSetIteratorPtr;
 
typedef OdSmartPtr<class OdSelectionSet>  OdSelectionSetPtr;
 
class ODRX_ABSTRACT FIRSTDLL_EXPORT OdSelectionSet : public OdRxObject
{
protected:
  OdSelectionSet();
public:
  ODRX_DECLARE_MEMBERS(OdSelectionSet);
 
  virtual const OdRxObject* baseDatabase() const = 0;
 
  virtual OdSelectionSetIteratorPtr newIterator() const = 0;
 
  // operations on the selection set 
 
  virtual OdUInt32 numEntities() const = 0;
 
  virtual OdUInt32 subentCount(OdDbStub* rootEntId = 0) const { return 0; }
 
  virtual void append(OdDbStub* entityId, OdDbSelectionMethod* pMethod = 0) = 0;
 
  virtual void append(const OdDbBaseFullSubentPath& subent, OdDbSelectionMethod* pMethod = 0) = 0;
 
  virtual void append(const OdSelectionSet* pSSet) = 0;
 
  virtual void remove(OdDbStub* entityId) = 0;
 
  virtual void remove(const OdDbBaseFullSubentPath& subent) = 0;
 
  virtual void remove(const OdSelectionSet* pSSet) = 0;
 
  virtual bool isMember(OdDbStub* entityId) const = 0;
 
  virtual bool isMember(const OdDbBaseFullSubentPath& subent) const = 0;
 
  virtual OdDbSelectionMethodPtr method(OdDbStub* entityId) const = 0;
 
  virtual void clear() = 0;
};
 
#endif //_SSET_H_