multipleChannelUtilities.h File Reference

Prototypes of utility functions for exampleMultipleChannels. More...

Go to the source code of this file.

Namespaces
namespace	makVrv
	REMOVE THIS along with the creator later.

Functions
makVrv::DtChannelConfiguration	makeChannelConfiguration (makVrv::DtDe &de, double left=0, double right=100, double bottom=0, double top=100)
	Helper function creates a channel-configuration with a default name.
makVrv::DtWindowConfiguration	makeWindowConfiguration (makVrv::DtDe &de, int x, int y, unsigned int numChannels=1)
	Helper function creates a window-configuration with a default name.
makVrv::DtDisplayConfiguration	makeDisplayConfiguration (makVrv::DtDe &de, const std::string &name="My Display Configuration")
	Helper function creates a display-configuration.
void	inspectDisplayWindows (makVrv::DtDe &de)
	Helper function to inspect the structure of the display, windows, channels and observers.
std::string	registerModelDefinition (makVrv::DtDe &de, const std::string &dataFile)
	Helper function populates a makVrv::DtModelDefinitionManager with a model- description for later use.
void	addModelToTheScene (makVrv::DtDe &de, const std::string &modelName)
	Helper function to load a geometry file and add it to the scene.
void	loadTheScene (makVrv::DtDe &de)
	Helper function to load all the models into the scene.

Detailed Description

Prototypes of utility functions for exampleMultipleChannels.

Function Documentation

makVrv::DtChannelConfiguration makeChannelConfiguration	(	makVrv::DtDe &	de,
		double	left = 0,
		double	right = 100,
		double	bottom = 0,
		double	top = 100
	)

Helper function creates a channel-configuration with a default name.

Channel parameter values are percentages of the windows dimensions. This example creates a separate observer for each channel because the observer identifies the model-set to be rendered. Without creating separate observers, each channel would render exactly the same scene.

makVrv::DtWindowConfiguration makeWindowConfiguration	(	makVrv::DtDe &	de,
		int	x,
		int	y,
		unsigned int	numChannels = 1
	)

Helper function creates a window-configuration with a default name.

The windows position must be specified, the number of channels is optional. These windows can be configured with one, two, three or four channels.

makVrv::DtDisplayConfiguration makeDisplayConfiguration	(	makVrv::DtDe &	de,
		const std::string &	name = "My Display Configuration"
	)

Helper function creates a display-configuration.

This configuration creates multiple windows each with multiple channels.

void inspectDisplayWindows

(

makVrv::DtDe &

de

)

Helper function to inspect the structure of the display, windows, channels and observers.

This function just prints their names to the console.

std::string registerModelDefinition	(	makVrv::DtDe &	de,
		const std::string &	dataFile
	)

Helper function populates a makVrv::DtModelDefinitionManager with a model- description for later use.

Generally, the manager loads all the model- descriptions from the disk, however, this example demonstrates how it is populated through code. This function returns the unique name generated for the model definition.

void addModelToTheScene	(	makVrv::DtDe &	de,
		const std::string &	modelName
	)

Helper function to load a geometry file and add it to the scene.

This function creates a makVrv::DtSceneObject which is used to position and move models around the scene. A makVrv::DtOsgSimpleModel is created to manage the model geometry. The makVrv::DtOsgSimpleModel is added to the makVrv::DtSceneObject to place the model geometry in to the scene.

void loadTheScene

(

makVrv::DtDe &

de

)

Helper function to load all the models into the scene.

For each model filename, this function creates a model-definition, then creates a scene-object to load that definition into the scene.