vreEntitySelectionFilter.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreEntitySelectionFilter.h
//! \ingroup vreManager
//! \brief Entity selection filter for VREngage Manager
//!
//! This file defines the DtVreEntitySelectionFilter class, which provides filtering
//! capabilities for entity selection within the VREngage Manager.
 
#pragma once
 
#include "vreManager/export.h"
#include <vrfGuiCore/vrfSelectionFilters.h>
 
//! \brief Unique identifier for the VREngage entity selection filter
const char DtVreEntitySelectionFilterId[] = "DtVreEntitySelectionFilter";
 
namespace makVrv
{
struct DtVrlinkSimulatedBaseState;
class DtDe;
} // namespace makVrv
 
namespace makVre
{
//! \brief Filter for selecting entities in the VREngage Manager
//!
//! This filter extends the VRF selection object filter with VREngage-specific
//! filtering capabilities, allowing selection of entities based on
//! VREngage-specific criteria.
class VREMANAGER_DLL DtVreEntitySelectionFilter : public makVrf::DtVrfSelectionObjectFilter
{
public:
   //! \brief Constructor
   //! \param de The distributed environment reference
   //!
   //! Initializes a new entity selection filter with the specified distributed environment.
   DtVreEntitySelectionFilter(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Destructor for proper cleanup of derived classes.
   virtual ~DtVreEntitySelectionFilter() override {};
 
   //! \brief Creates a copy of this filter
   //! \return Pointer to a new dynamically allocated copy
   //!
   //! Creates a clone of this filter for use in filter collections or for copying filters.
   virtual DtVrfSelectionFilter* clone() const override { return new DtVreEntitySelectionFilter(*this); };
 
   //! \brief Determines if a simulation object passes the filter
   //! \param simObject The simulation object reference to check
   //! \return True if the object passes the filter criteria, false otherwise
   //!
   //! Evaluates whether a simulation object should be included in the filtered selection
   //! based on VREngage-specific criteria.
   virtual bool isValid(const makVrf::DtSimObjectReference& simObject) const override;
 
protected:
   //! \brief Reference to the distributed environment
   //!
   //! Used to access simulation state information for filtering decisions.
   makVrv::DtDe& myDe;
};
} // namespace makVre