vreVrvUtil.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
//! \file vreVrvUtil.h
//! \ingroup vreUtil
//! \brief Utility functions for working with VRV (Vantage Runtime Visual) components
//!
//! This file provides helper functions for finding and manipulating various VRV components
//! such as windows, channels, and observers, as well as applying configurations to channels.
//! These utilities simplify common operations in the VREngage application.
 
#pragma once
 
#include "export.h"
 
#include <string>
 
namespace makVrv
{
class DtWindow;
class DtDe;
class DtChannel;
class DtOsgChannel;
class DtObserver;
class DtChannelConfiguration;
} // namespace makVrv
 
namespace makVre
{
//! \brief Finds a window by name in the display engine
//! \param de Reference to the display engine to search in
//! \param windowName Name of the window to find (defaults to "Window 1")
//! \return Pointer to the found window, or nullptr if not found
//!
//! This function searches for a window with the specified name in the display engine.
UTIL_DLL makVrv::DtWindow* findWindow(makVrv::DtDe& de, const std::string& windowName = "Window 1");
 
//! \brief Finds a channel by name in a specific window
//! \param de Reference to the display engine to search in
//! \param channelName Name of the channel to find (defaults to "Channel 1")
//! \param windowName Name of the window containing the channel (defaults to "Window 1")
//! \return Pointer to the found channel, or nullptr if not found
//!
//! This function searches for a channel with the specified name in the specified window.
UTIL_DLL makVrv::DtChannel* findChannel(
   makVrv::DtDe& de, const std::string& channelName = "Channel 1", const std::string& windowName = "Window 1");
 
//! \brief Finds an OSG channel by name in a specific window
//! \param de Reference to the display engine to search in
//! \param channelName Name of the channel to find (defaults to "Channel 1")
//! \param windowName Name of the window containing the channel (defaults to "Window 1")
//! \return Pointer to the found OSG channel, or nullptr if not found
//!
//! This function searches for an OSG channel with the specified name in the specified window.
//! It is similar to findChannel but specifically returns a DtOsgChannel pointer.
UTIL_DLL makVrv::DtOsgChannel* findOsgChannel(
   makVrv::DtDe& de, const std::string& channelName = "Channel 1", const std::string& windowName = "Window 1");
 
//! \brief Finds an observer by name in the display engine
//! \param de Reference to the display engine to search in
//! \param observerName Name of the observer to find (defaults to "Observer 1")
//! \return Pointer to the found observer, or nullptr if not found
//!
//! This function searches for an observer with the specified name in the display engine.
UTIL_DLL makVrv::DtObserver* findObserver(makVrv::DtDe& de, const std::string& observerName = "Observer 1");
 
//! \brief Applies a channel configuration to a channel specified by name
//! \param de Reference to the display engine containing the channel
//! \param channelName Name of the channel to configure
//! \param windowName Name of the window containing the channel
//! \param config The channel configuration to apply
//! \return True if the configuration was successfully applied, false otherwise
//!
//! This function finds a channel by name and applies the specified configuration to it.
UTIL_DLL bool applyChannelConfig(makVrv::DtDe& de, const std::string& channelName, const std::string& windowName,
   const makVrv::DtChannelConfiguration& config);
 
//! \brief Applies a channel configuration to a specific channel
//! \param de Reference to the display engine
//! \param channel Reference to the channel to configure
//! \param config The channel configuration to apply
//! \return True if the configuration was successfully applied, false otherwise
//!
//! This function applies the specified configuration to the provided channel.
//! This overload is more efficient when you already have a reference to the channel.
UTIL_DLL bool applyChannelConfig(
   makVrv::DtDe& de, const makVrv::DtChannel& channel, const makVrv::DtChannelConfiguration& config);
 
} // namespace makVre