exampleEffectTexturePlugin

Table of Contents

• Overview
• Expected Result
• Example details
• Building the Example
• Running the Example
• Example Source Files
• DtExampleEffectTextureController.cxx
• DtExampleEffectTextureController.h
• exampleEffectTexturePlugin.h
• exampleEffectTexturePluginInit.cxx
• exampleEffectTexturePluginInit.h

Overview

Shows how to create a custom effect texture type on loaded model

Expected Result

Effect Texure Plugin Result

Example details

VR-Vantage has a concept of Effect Textures. These effect textures allow you to have additional textures on a model without needing to edit the actual model file. This is how normal maps, emissivity maps, or any other secondary textures are configured in VR-Vantage. See section 24.7 of the VR-Vantage Users Guide for an explaination of the effect textures that are currently supported.

This example shows how to create a custom effect texture type and configure it to be applied to any model that has specially named textures.

The class DtExampleEffectTextureController is the main class to look at for this example. The constructor sets up the vertex and fragment shaders that will be used when an EET texture is loaded. The generateShaders() function sets up the final version of the shader text and loads the shaders as virtual program functions (see exampleCustomShader for an explaination about how virtual programs work). getEffectTypeCode() specifies which texture Postfix should be used to determine if this effect texture controller should be used.

Building the Example

VR-Vantage includes pre-built versions of the example plug-in. To build it yourself, follow the instructions at Building VR-Vantage Examples, Applications, and Plug-ins.

Running the Example

This example is a plug-in. You can run it by running ./bin64/exampleEffectTexturePlugin_stealth.bat (on Windows) or ./bin64/exampleEffectTexturePlugin_stealth.sh (on Linux). Please add your shared data dir to the script in order to allow it to work correctly. This example is intended to be run without a terrain. Use your mouse wheel to get closer to the helicopter. Press 't' to change the effect on the helicopter. For more information about running examples, please see Running Applications and Examples. Close the open Terrain dialog to see the Helicopter that is loaded by the example.

The script that runs the example will also create the EET texture used by the example. On windows you may have to run the script in admin mode.

When running the example push the T key to turn the effect on or off. Notice the camo on the helicopter switch from blue to brown when the effect texture is toggled.

Example Source Files

• DtExampleEffectTextureController.cxx
• DtExampleEffectTextureController.h
• exampleEffectTexturePlugin.h
• exampleEffectTexturePluginInit.cxx
• exampleEffectTexturePluginInit.h

---

DtExampleEffectTextureController.cxx

/******************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#include "exampleEffectTexturePluginInit.h"
#include "DtExampleEffectTextureController.h"

#include <vrvCore/DtDe.h>
#include <matrix/vlMath.h>

#include <vrvOsg/DtOsgEffectTextureController.h>
#include <vrvOsg/DtEffectControllerFactory.h>
#include <vrvOsg/DtOsgShaderUtils.h>
#include <vrvOsg/DtVirtualProgramDepthOnlyCallback.h>
#include <vrvOsg/DtVirtualProgramExecutionPriority.h>
#include <vrvOsg/DtEffectTextureRegistry.h>
#include <vrvOsg/DtVirtualProgramParams.h>

#include <osg/StateSet>
#include <osg/Texture>
#include <osg/Texture2DArray>

#include <osgEarth/VirtualProgram>
#include <osgEarth/StringUtils>

using namespace makArchives;

namespace makVrv
{
   
   const std::string ExampleMapFragFunctionName = "example_effect_texture_frag";
   const std::string ExampleMapVertFunctionName = "example_effect_texture_vert";
   const std::string ExampleMapFragFilePath = "../../../examples/exampleEffectTexturePlugin/exampleEffect.frag.glsl";
   const std::string ExampleMapVertFilePath = "../../../examples/exampleEffectTexturePlugin/exampleEffect.vert.glsl";
   const std::string ExampleMapIndirectFragFilePath = "/../../examples/exampleEffectTexturePlugin/exampleEffect.frag.glsl";
   const std::string ExampleMapEffectUnitName = "example_effect_texture_tex";
   const std::string ExampleMapPostfix = "EET";

   osg::ref_ptr< osg::Uniform > DtExampleEffectTextureController::effectEnabledUniform = NULL;

   void DtExampleEffectTextureController::toggleEffectEnabled()
   {
      if(effectEnabledUniform != NULL)
      {
         bool curVal = false;
         effectEnabledUniform->get(curVal);
         effectEnabledUniform->set(!curVal);
      }
   }

   DtExampleEffectTextureController::DtExampleEffectTextureController(DtDe& de)
      : DtOsgEffectTextureController(de, ETT_CUSTOM_MAP, "EET")
   {
      if(!effectEnabledUniform)
      {
         effectEnabledUniform = new osg::Uniform("vrv_exampleEffectTextureEnabled", true);
      }
      DtEffectTextureRegistry& registry = DtEffectTextureRegistry::instance(de);
      registry.registerEffectTextureType(ETT_CUSTOM_MAP, "example map", "ETT_CUSTOM_MAP", "EET", false);

      registry.registerIndirectShaderEffectTexturetype(ETT_CUSTOM_MAP,
         DtIndirectEffectTextureShader(ExampleMapFragFunctionName, ExampleMapIndirectFragFilePath,
         1.75, "example_effect_texture_tex64", "example_effect_texture_coord"));
   }

   DtExampleEffectTextureController::~DtExampleEffectTextureController()
   {
      //nop
   }
   bool DtExampleEffectTextureController::installShaders(int baseUnit, int effectUnit, const osg::Texture* tex, osg::StateSet* stateSet, const std::string& baseTextureName) const
   {

      DtVirtualProgramParams params;

      params.vertShader = ExampleMapVertFilePath;
      params.fragShader = ExampleMapFragFilePath;

      params.vertFunction = ExampleMapVertFunctionName;
      params.fragFunction = ExampleMapFragFunctionName;

      params.vertFuncLoc = osgEarth::VirtualProgram::LOCATION_VERTEX_VIEW;
      params.fragFuncLoc = osgEarth::VirtualProgram::LOCATION_FRAGMENT_LIGHTING;

      params.vertExecPrio = DtVirtualProgramExecutionPriority::ReflectivityMapVertexView;
      // run before regular lighting
      params.fragExecPrio = 1.75;

      params.unitWhoseCoordsToReplace = baseUnit;
      params.effectUnitName = ExampleMapEffectUnitName;

      osgEarth::VirtualProgram* vp = installVirtualProgram(baseUnit, effectUnit, tex, stateSet, baseTextureName, params);

      stateSet->addUniform(effectEnabledUniform);

      return vp != NULL;
   }


   DtOsgEffectTextureController* DtExampleEffectTextureControllerCreator::create(DtDe& de)
   {
      return new DtExampleEffectTextureController(de);
   }
   
}

DtExampleEffectTextureController.h

/******************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
#pragma once


#include "exampleEffectTexturePlugin.h"
#include "exampleEffectTexturePluginInit.h"

#include <vrvCore/DtDe.h>

#include <vrvOsg/DtOsgEffectTextureController.h>
#include <vrvOsg/DtEffectControllerFactory.h>

#include <osg/StateSet>
#include <osg/Texture>

using namespace makArchives;

namespace makVrv
{
   class DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN DtExampleEffectTextureController : public DtOsgEffectTextureController
   {
   public:
      DtExampleEffectTextureController(DtDe& de);
         
      virtual ~DtExampleEffectTextureController();

      virtual bool installShaders(int baseUnit, int effectUnit, const osg::Texture* tex, osg::StateSet* stateSet, const std::string& baseTextureName) const;

      static void toggleEffectEnabled();

   private:
      static osg::ref_ptr< osg::Uniform > effectEnabledUniform;

      static const std::string myVertSource;
      static const std::string myFragSource;

   };

   class DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN DtExampleEffectTextureControllerCreator : public DtEffectControllerCreator
   {
   public:
      virtual DtOsgEffectTextureController* create(DtDe& de);
   };
}

exampleEffectTexturePlugin.h

/******************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#ifndef EXAMPLEEFFECTTEXTUREPlugin_H_
#define EXAMPLEEFFECTTEXTUREPlugin_H_

#ifdef _WIN32
#ifdef EXAMPLEEFFECTTEXTUREPLUGIN_EXPORTS
#define DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN __declspec ( dllexport )
#else
#define DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN __declspec ( dllimport )
#endif
#else
#define DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN
#endif


#endif

exampleEffectTexturePluginInit.cxx

/******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#include "exampleEffectTexturePluginInit.h"
#include "DtExampleEffectTextureController.h"

#include <vrvCore/DtDe.h>
#include <vrvCore/DtModelInstance.h>
#include <vrvCore/DtModelDefinition.h>

#include <vrvOsg/DtOsgEffectTextureController.h>
#include <vrvOsg/DtEffectControllerFactory.h>
#include <vrvOsg/DtOsgRenderer.h>
#include <vrvOsg/DtOsgSimpleModelInstance.h>
#include <vrvOsg/DtOsgEmptySceneLogo.h>

#include <osg/PositionAttitudeTransform>
#include <vrvCore/DtInputDriver.h>
#include <vrvCore/DtKeyMapManager.h>
#include <vrvCore/DtDriverManager.h>

#include <vrvUtil/signalslib.h>


// The name of the geometry file to load. The custom effect texture for this model is 
// created by the exampleEffectTexturePlugin run script and is called DB_UH60L_1024_DESERT_CAMO_EET_rgb.meif
static const std::string dataFile =
   "/ModelData/Vehicles/RotaryWing/UH-60L_BLACK_HAWK_DESERT_CAMO_V7.0/DB_UH-60L_DESERT_CAMO_V7.0.medf";


using namespace makVrv;

static vrvSignalsLib::connection postInitializeConnection;

// This is a helper function to load a geometry file and add it to the scene-
// graph.  A model-definition is first given to a model-instance telling it
// which geometry file is to be loaded.  Then the realize() function is called
// on the model-instance to load the file from disk.  Last the root node from
// the model-instance is added to the scene-graph.
void slot_postInitialize(DtDe* de)
{
   // Create a model definition describing the model to load.
   // The DtModelDefinition class is used to describe several attributes about
   // the model.  For this example we just specify the name of the geometry
   // file to load.
   DtModelDefinition md("theModel");
   std::string sharedDataPath = de->dePathConfiguration().sharedDataPath();
   md.setParameter("filename", sharedDataPath+dataFile);

   // Create a model instance and load a file from the model definition.
   // In this example we use a DtOsgSimpleModelInstance as the type of model-
   // instance that will be added to the scene.  Since we are creating this
   // object directly without the use of a factory, we're required to call
   // the realize() function to actually load the model.
   DtOsgSimpleModelInstance* mi = new DtOsgSimpleModelInstance(*de);
   if (! mi->realize(md))
   {
      delete mi;
      return;
   }

   // Create a transform to move the model away from the origin.
   // The default observer starts at 0,0,0.  Move the transform, 100 units
   // away and rotate it to look nice.
   osg::ref_ptr<osg::PositionAttitudeTransform> pat = 
      new osg::PositionAttitudeTransform();

   pat->setPosition(osg::Vec3(0,100,0));
   pat->setAttitude(osg::Quat(
      osg::DegreesToRadians(-10.0f),  osg::Vec3(1.0f, 0.0f, 0.0f),
      osg::DegreesToRadians(-30.0f), osg::Vec3(0.0f, 1.0f, 0.0f),
      osg::DegreesToRadians(150.0f), osg::Vec3(0.0f, 0.0f, 1.0f)));

   // Add the root-node of the model to the transform.
   pat->addChild(mi->rootNode());

   // Add the transform to the prop-root of the renderer.
   DtOsgRenderer& renderer = (DtOsgRenderer&)de->renderer();
   renderer.addNodeToRoot(pat, renderer.propRoot());
   
   //Connect the example effect texture enable uniform to the T key
   DtInputDriver& inputDriver = 
      de->driverManager().inputDriver();

   DtKeyMapManager& keyMapManager = DtKeyMapManager::instance(*de);

   keyMapManager.addKeyFunction( "Toggle Example Effect Texture", std::bind( 
      &DtExampleEffectTextureController::toggleEffectEnabled), DtKeyMapManager::Rendering );

   DtKeyMap* obsFrame = keyMapManager.findKeyMap( "Observer Frame" );

   if ( obsFrame )
   {
      inputDriver.addKeyBinding( obsFrame, DtKeyState::KEY_T, 
         "Toggle Example Effect Texture" );
   }

   // We're done with the signal, so disconnect from it
   postInitializeConnection.disconnect();
}

bool initDeModule(makVrv::DtDe* de)
{
   DtOsgEmptySceneLogo::setEnabled( false );
   makVrv::vrvExampleEffectTexturePlugin::init(*de);
   return true;
}

using namespace makArchives;

namespace makVrv
{
   namespace vrvExampleEffectTexturePlugin
   {      
      void init(DtDe& de)
      {
         DT_DE_INIT_ONCE(de);

         makVrv::vrvOsg::init(de);
         
         DtEffectControllerFactory& ecf = DtEffectControllerFactory::instance(de);
         ecf.registerCreator("DtExampleEffectTextureController", new DtExampleEffectTextureControllerCreator());

         // Add a model to the scene graph after the de has initialized
         postInitializeConnection = de.signal_postInitialize.connect(std::bind(
            &slot_postInitialize, &de));
            
      }
   }
}

exampleEffectTexturePluginInit.h

/******************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

#pragma once

// Get proper local export symbol
#include "exampleEffectTexturePlugin.h"

// Setup proper plugin export symbol
#define DT_DE_PLUGIN_EXPORT_MACRO DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN

// Export plugging function bool initDeModule(DtDe* de);
#include <vrvCore/exportPlugin.h>

namespace makVrv
{
   class DtDe;
   namespace vrvExampleEffectTexturePlugin
   {
      DT_DLL_EXAMPLEEFFECTTEXTUREPLUGIN void init(DtDe& anIG);
   }
}

[<< Examples] [Home] [Top of Page]