TrRndStateBranchClient.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.
// State branch access clients.
 
#ifndef ODTRRNDSTATEBRANCHCLIENT
#define ODTRRNDSTATEBRANCHCLIENT
 
#include "TD_PackPush.h"
 
#include "RxObject.h"
#include "../TrVisDefs.h"

class OdTrRndMarkersAccessor
{
public:
  virtual bool empty() const = 0;
  virtual bool hasMarker( OdGsMarker marker ) const = 0;
  virtual bool interval( OdGsMarker& minMarker, OdGsMarker& maxMarker ) const { return false; }
};
 
// State branch childs iterator
typedef const void *OdTrVisStateChildIt;
// State branch markers pointer
typedef const void *OdTrVisStateMarkerPtr;
// State branch markers iterator
struct OdTrVisStateMarkerIt
{
  OdTrVisStateMarkerPtr m_pData[4];
  OdTrVisStateMarkerIt(OdTrVisStateMarkerPtr pPtr = nullptr) { m_pData[0] = pPtr; }
  operator OdTrVisStateMarkerPtr() const { return *m_pData; }
  bool isNull() const { return *m_pData == nullptr; }
};

struct OdTrRndStateBranchClientInterface
{
  virtual OdTrVisStateBranchPtr stateBranchGetPtr(OdTrVisStateBranchId stateBranchId) const = 0;
  virtual OdTrVisStateBranchId stateBranchId(OdTrVisStateBranchPtr pStateBranch) const = 0;
  virtual void stateBranchLock(OdTrVisStateBranchId stateBranchId) const = 0;
  virtual bool stateBranchUnlock(OdTrVisStateBranchId stateBranchId) const = 0;
  virtual bool stateBranchIsEmpty(OdTrVisStateBranchPtr pStateBranch) const = 0;
  virtual bool stateBranchHasMarkers(OdTrVisStateBranchPtr pStateBranch) const = 0;
  virtual OdTrVisStateBranchPtr stateBranchGetChild(OdTrVisStateBranchPtr pStateBranch, OdTrVisOwning childId) const = 0;
  virtual OdTrVisStateChildIt stateBranchNextChild(OdTrVisStateBranchPtr pStateBranch, OdTrVisStateChildIt it = nullptr, OdTrVisStateBranchId *pChildId = nullptr) const = 0;
  virtual OdTrVisStateMarkerPtr stateBranchHasMarker(OdTrVisStateBranchPtr pStateBranch, OdTrVisGsMarker gsMarker) const = 0;
  virtual OdTrVisStateMarkerIt stateBranchNextMarker(OdTrVisStateBranchPtr pStateBranch, OdTrVisStateMarkerIt it = nullptr, OdTrVisGsMarker *pMarkerId = nullptr) const = 0;
  virtual OdUInt32 stateBranchIntegerParam(OdTrVisStateBranchPtr pStateBranch, OdTrVisStateMarkerPtr pMarker = nullptr) const = 0;
  virtual const OdGeMatrix3d &stateBranchMatrixParam(OdTrVisStateBranchPtr pStateBranch, OdTrVisStateMarkerPtr pMarker = nullptr) const = 0;
  virtual OdTrRndMarkersAccessor* stateBranchMarkers( OdTrVisStateBranchPtr pStateBranch ) const = 0;
  virtual void releaseMarkersAccessor( OdTrRndMarkersAccessor* pAccessor ) const = 0;
};

class OdTrRndStateBranchClient : public OdRxObject, public OdTrRndStateBranchClientInterface
{
};

typedef OdSmartPtr<OdTrRndStateBranchClient> OdTrRndStateBranchClientPtr;
 
#include "TD_PackPop.h"
 
#endif // ODTRRNDSTATEBRANCHCLIENT