DtOsgLightPointManager registers LightPoint nodes so their TBO can be created and updated in a single place. Main access point for adding light points to the new system. It registers the light points which (if enabled) replaces the.

See Also: osgSim::LightPointNodes with; DtLightPointNodes or just passes a pointer for the; DtOsgLightPointManager to the; DtLightPointNode in the case of CDB light points. It also converts; osgSim::LightPoint objects to a light point type and manages the loading of the light point table which has the default light point types in it. Creates the; DtLightPointDrawable object that draws all the light points. Handles the creation and updating of the SSBO(Shader Storage Buffer Object) which is how the light type, light node, and light group data is passed down to the GPU. Sets up the shaders which are added as Virtual Program functions to the; DtLightPointDrawable. Sets up the imGui debug gui which can turn on debug labels and adjust the intensity of the light point groups.

Inheritance diagram for makVrv::DtOsgLightPointManager:

[legend]

Public Member Functions
	DtOsgLightPointManager (DtDe &de)

virtual void	findAndRegisterLightPoints (osg::Node *node, const DtLightPointRegistrationParameters &params)

virtual void	registerLightPoints (const DtLightPointNodeAndXformVector &lightPoints, const DtLightPointRegistrationParameters &params)

virtual DtLightPointNode *	createLightPointNode (osg::Node *nodeRef, bool daylightControlled)

virtual DtGlBuffer *	lightPointTypeBuffer ()

virtual DtGlBuffer *	lightPointGroupBuffer ()

virtual DtGlBuffer *	lightPointNodeBuffer (osg::Camera *camera)

virtual void	updateLightPointVertexBuffer (const std::vector< DtLightPointDrawable::LightPointVertexAttrib > &vertexAttribData, int minChanged, int maxChanged)

virtual DtGlBuffer *	lightPointVertexBufer ()

virtual int	nodeId (DtLightPointNode *lpNode, int instanceId)

virtual void	slot_preTick ()

virtual void	slot_attributesChanged (const DtElementAttributeManager::EntryAttributesList &)

virtual void	clearNodeBuffer (const osg::Camera *camera)

unsigned int	nodeBufferMaxNodeId (const osg::Camera *camera)

virtual void	setNodeBufferData (int nodeId, const osg::Camera *camera, const DtLightPointNodeDataLayout &nodeData)

virtual void	processImGui ()

virtual DtLightPointDrawable *	masterLightPointDrawable ()

virtual bool	debugLabelsEnabled () const

virtual bool	debugDirectionEnabled () const

virtual bool	softerLightPointsEnabled () const

virtual float	softenIntensity () const

virtual void	setShouldReplaceOsgSimLightPoints (bool enable)

virtual bool	shouldReplaceOsgSimLightPoints ()

virtual void	freeNodeIds (std::vector< int > &nodeIds)

virtual void	releaseGLObjects (osg::State *state) const

virtual void	setInstanceReflectionMatrix (const osg::Camera *camera, const osg::Matrixf &reflectMat)

virtual const osg::Matrixf &	instanceReflectionMatrix (const osg::Camera *camera)

virtual bool	entityInstanceGroupInformation (const std::string &modelDefinitionName, const std::string &entityInstanceName, int &firstGroupId, int &numberOfLightPointGroups)

virtual int	entitySubLightPointGroupIndex (const std::string &modelDefinitionName, const std::string &subLightPointGroupName)

virtual void	removeGroupsForEntityInstance (const std::string &modelDefinitionName, const std::string &entityInstanceName)

virtual int	registerNewEntityInstanceAndGetStartingGroupIdIndex (const std::string &modelDefinitionName, const std::string &entityInstanceName)

virtual bool	drawLightPoints ()

virtual DtDebugLabelMode	debugLabelMode () const

virtual const std::string	searchNodeHierarchyForGroupName (osg::Node *sourceNode) const

Public Member Functions inherited from makVrv::DtLightPointManager
	DtLightPointManager (DtDe &de)

virtual bool	groupExists (const std::string &group) const

virtual DtColorValue	groupColor (const std::string &group)

virtual int	groupId (const std::string &group, bool increaseReferenceCount=false)

virtual int	lightPointMaxCode ()

void	setGroupColor (const std::string &group, float colorR, float colorG, float colorB, float colorA)

virtual void	setGroupColor (const std::string &group, const DtColorValue &color, bool createGroupIfNonexistent=true)

virtual const GroupIdMap &	groupIdMap ()

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtOsgLightPointManager &	instanceAsDtOsgLightPointManager (DtDe &de)

Static Public Member Functions inherited from makVrv::DtLightPointManager
static bool	isLightPointGroupNameComplete (const std::string &lightPointGroupName)

static DtLightPointManager &	instance (DtDe &de)

static void	registerInstance (DtDe &de, DtLightPointManager *manager)

static const std::string &	theClassName ()

static float	defaultLightPointRange ()

Public Attributes
boost::signalslib::signal < void(LightPointNodeObsSet &)>	signal_lightPointsRegistered

boost::signalslib::signal < void(DtDebugLabelMode)>	signal_debugLabelModeChanged

Protected Types
typedef std::map< const osg::Camera *, std::vector < float > >	CameraVectorMap

typedef std::pair < DtLightPointNode *, int >	nodeIntPair

typedef std::map< nodeIntPair, int >	NodeIdMap

typedef std::map< std::string, GroupIdMap >	ParentGroupIdMap

Protected Member Functions
virtual	~DtOsgLightPointManager ()

virtual void	slot_reloadShaders ()

virtual void	setupShaders ()

const std::string	parseNodeGroupName (osg::Node *node) const

virtual LightPointNodeObsSet	aggregateLightPoints (const DtLightPointNodeAndXformVector &lightPoints, const DtLightPointRegistrationParameters &params)

virtual void	populateLightPointNode (osg::Node nodeRef, DtLightPointNode dtLpRef, bool daylightControlled, bool newNode)

virtual const std::string	specialCaseSearchForCreatorGeneratedRunwayGroups (osg::Node *searchNode) const

Protected Member Functions inherited from makVrv::DtLightPointManager
virtual	~DtLightPointManager ()

void	local_setGroupColor (const std::string &group, const DtColorValue &color, bool createGroupIfNonexistent)

Static Protected Member Functions
static void	cleanupNodes (osg::Node *node)

Protected Attributes
DtGlBuffer *	myLightPointTypeBuffer

DtGlBuffer *	myLightPointGroupBuffer

CameraVectorMap	myLightPointNodeDataMap

DtGlBuffer *	myLightPointNodeBuffer

DtGlBuffer *	myLightPointVertexBuffer

NodeIdMap	myNodeIds

std::set< int >	myFreeNodeIds

boost::mutex	myMutex

boost::mutex	myNodeIdMutex

boost::recursive_mutex	myNodeBufferMutex

boost::shared_mutex	myLightsTableMutex

osg::ref_ptr < DtLightPointDrawable >	myMasterLightPointDrawable

bool	myDebugLabelsEnabled

DtDebugLabelMode	myDebugLabelMode

bool	myDebugDirectionEnabled

bool	myShouldReplaceOsgSimLightPoints

bool	mySofterLightPointsEnabled

float	mySoftenIntensity

bool	myDrawLightPoints

GroupIdMap	myImGuiProcessedGroupIds

ParentGroupIdMap	myImGuiGroups

DtSignalConnectionManager	myImGuiDisplayNameAttributeChangedConnection

std::map< const osg::Camera *, osg::Matrixf >	myInstanceReflectionMatrix

LightPointNodeObsSet	myLightPointNodes

DtDe &	myDtDe

Protected Attributes inherited from makVrv::DtLightPointManager
DtSignalConnectionManager	mySignals

DtDe &	myDe

DtLightPointTable	myLightsTable

GroupIdMap	myGroupIds

std::map< std::string, std::vector< std::string > >	myEntityTypeNameToSubGroupNamesMap

DtReservedElementsBuffer < DtColorValue >	myGroupColors

std::map< std::string, DtColorValue >	myColorsAwaitingGroupCreation

int	myLastUpdateLightPointMaxCode

Private Member Functions
	DtOsgLightPointManager ()=delete

	DtOsgLightPointManager (const DtOsgLightPointManager &other)=delete

DtOsgLightPointManager &	operator= (const DtOsgLightPointManager &other)=delete

Additional Inherited Members
Public Types inherited from makVrv::DtLightPointManager
typedef std::pair< std::string, DtLightPointGroupEntry >	GroupIdPair

typedef std::map< std::string, DtLightPointGroupEntry >	GroupIdMap

Static Protected Attributes inherited from makVrv::DtLightPointManager
static const std::string	theLightFilename

static const std::string	theLightTunningFilename

static const std::string	theLightDefaultValuesXmlFilename

static const std::string	theLightDefaultValuesCsvFilename

Member Typedef Documentation

typedef std::map<const osg::Camera*, std::vector<float> > makVrv::DtOsgLightPointManager::CameraVectorMap

protected

typedef std::pair<DtLightPointNode*, int> makVrv::DtOsgLightPointManager::nodeIntPair

protected

typedef std::map<nodeIntPair, int> makVrv::DtOsgLightPointManager::NodeIdMap

protected

typedef std::map<std::string, GroupIdMap> makVrv::DtOsgLightPointManager::ParentGroupIdMap

protected

Constructor & Destructor Documentation

makVrv::DtOsgLightPointManager::DtOsgLightPointManager ( DtDe & de )

Light point manager contructor used by instance() call to setup the singleton instance.

makVrv::DtOsgLightPointManager::DtOsgLightPointManager ( )

privatedelete

No default construction allowed.

makVrv::DtOsgLightPointManager::DtOsgLightPointManager ( const DtOsgLightPointManager & other )

privatedelete

Copy Constructor not implemented – Copy Not Allowed.

virtual makVrv::DtOsgLightPointManager::~DtOsgLightPointManager ( )

protectedvirtual

DTOR.

Member Function Documentation

static DtOsgLightPointManager& makVrv::DtOsgLightPointManager::instanceAsDtOsgLightPointManager ( DtDe & de )

static

get the DtOsgLightPointManger from the de instance registry

DtOsgLightPointManager& makVrv::DtOsgLightPointManager::operator= ( const DtOsgLightPointManager & other )

privatedelete

Assignment Operator Not implemented – Assignment Not Allowed.

virtual void makVrv::DtOsgLightPointManager::findAndRegisterLightPoints	(	osg::Node *	node,
		const DtLightPointRegistrationParameters &	params
	)

virtual

Traverse the provided node and find all the light points and then pass them to registerLightPoints.

When light points are registered as indirected, i.e. isIndirected is set to true, then the group ids set on the light point node starts at 0 and increases by one with each unique light point group found in the model. This is because the light point node is shared between multiple instances and therefore the light point node's group id must be agnostic of the instance - for more information see the documentation for DtOsgLightPointManager::lightPointGroupBuffer.

Parameters

node	The node whose hierarchy we will search for light point nodes.
groupName	The alias, complete or not, to associate the registered light point nodes under. For more information, see DtOsgLightPointManager::isLightPointGroupNameComplete.
modelDefinitionName	The name of the model definition associated with the node. This is only used if isIndirected is true.
daylightControlled	This is only used if the light points do not already have a type specified.
fadeParameters	Parameters which controls how the registered light points will fade.
combineLightPoints	Should only be true for nodes belonging to osgEarth::Layer objects.
isIndirected	If true, the group ids set on the light point nodes will be set differently.

virtual void makVrv::DtOsgLightPointManager::registerLightPoints	(	const DtLightPointNodeAndXformVector &	lightPoints,
		const DtLightPointRegistrationParameters &	params
	)

virtual

Register a list of non instanced light points.

When light points are registered as indirected, i.e. isIndirected is set to true, then the group ids set on the light point node starts at 0 and increases by one with each unique light point group found in the model. This is because the light point node is shared between multiple instances and therefore the light point node's group id must be agnostic of the instance - for more information see the documentation for DtOsgLightPointManager::lightPointGroupBuffer.

Parameters

node	The node whose hierarchy we will search for light point nodes.
groupName	The alias, complete or not, to associate the registered light point nodes under. For more information, see DtOsgLightPointManager::isLightPointGroupNameComplete.
modelDefinitionName	The name of the model definition associated with the node. This is only used if isIndirected is true.
daylightControlled	This is only used if the light points do not already have a type specified.
fadeParameters	Parameters which controls how the registered light points will fade.
combineLightPoints	Should only be true for nodes belonging to osgEarth::Layer objects.
isIndirected	If true, the group ids set on the light point nodes will be set differently.

virtual DtLightPointNode* makVrv::DtOsgLightPointManager::createLightPointNode	(	osg::Node *	nodeRef,
		bool	daylightControlled
	)

virtual

Create a DtLightPointNode based on an osgSim::LightPointNode also removes the osgSim::LightPointNode from the scenegraph Does nothing if shouldReplaceOsgSimLightPoints is set to false which is currently the default setting. daylightControlled is only used if the light points do not already have a type specified.

virtual DtGlBuffer* makVrv::DtOsgLightPointManager::lightPointTypeBuffer ( )

virtual

Get and setup the light point type SSBO used for rendering the light points. this buffer contains the data from the DtLightPointTable reorganized into a tightly packed list of only the data that is needed by the shader.

virtual DtGlBuffer* makVrv::DtOsgLightPointManager::lightPointGroupBuffer ( )

virtual

Get and setup the light point group SSBO. This buffer contains the intensity settings for all of the light point groups.

For indirect geometries:

instanceVertexInfo.group() represents the intial offset into the group color buffer to get to beginning of the chunk of the buffer that contains the instance's light point group colors.
The nodeGroupId represents an additional offset for the specific light point group of interest.

For example, if you have two instances (Bob & Bill) of the same model which has two light point groups (anchor_lights & spot_lights) configured for it, the buffer may look like: ... | Bob:anchor_lights | Bob:spot_lights | Bill:anchor_lights | Bill:spot_lights | ... index 21 index 22 index 23 index 24 The light point node(s) will be shared between Bob and Bill, so the group id on the light point node(s) belonging to each light point group would be:

anchor_lights is 0
spot_lights is 1 The instance will keep track of the initial offset, in this example the instance offset would be:
Bob is 21
Bill is 23

virtual DtGlBuffer* makVrv::DtOsgLightPointManager::lightPointNodeBuffer ( osg::Camera * camera )

virtual

Get and setup the light point node buffer SSBO. This contains all the model view matrices for all the light point nodes. there is a node buffer per camera because we need a view matrix for each camera.

virtual void makVrv::DtOsgLightPointManager::updateLightPointVertexBuffer	(	const std::vector< DtLightPointDrawable::LightPointVertexAttrib > &	vertexAttribData,
		int	minChanged,
		int	maxChanged
	)

virtual

positions and information about their direction and blinking. Also contains ids for the type, node, and group

virtual DtGlBuffer* makVrv::DtOsgLightPointManager::lightPointVertexBufer ( )

virtual

get the ssbo for the light point vertex data. This contains the light point positions and information about their direction and blinking. Also contains ids for the type, node, and group

virtual int makVrv::DtOsgLightPointManager::nodeId	(	DtLightPointNode *	lpNode,
		int	instanceId
	)

virtual

get the node id for the specified node and instance

virtual void makVrv::DtOsgLightPointManager::slot_preTick ( )

virtual

handle the preTick signal. This clears the light point node buffer and updates the imGui

virtual void makVrv::DtOsgLightPointManager::slot_attributesChanged ( const DtElementAttributeManager::EntryAttributesList & )

virtual

virtual void makVrv::DtOsgLightPointManager::clearNodeBuffer ( const osg::Camera * camera )

virtual

Clear the node buffer for a particular camera.

unsigned int makVrv::DtOsgLightPointManager::nodeBufferMaxNodeId ( const osg::Camera * camera )

get the number of node ids avilable for this camera's node buffer

virtual void makVrv::DtOsgLightPointManager::setNodeBufferData	(	int	nodeId,
		const osg::Camera *	camera,
		const DtLightPointNodeDataLayout &	nodeData
	)

virtual

Set the light point node data for a particular node id (a node id is a one to one mapping to a node + instance) posScale is used to scale the position of the light point when model scaling is being used with instanced models radiusScale is used to scale the radius of the light point when model scaling is being used with any model.

virtual void makVrv::DtOsgLightPointManager::processImGui ( )

virtual

Update the imGui debug Gui and process any changes from the Gui.

virtual DtLightPointDrawable* makVrv::DtOsgLightPointManager::masterLightPointDrawable ( )

virtual

Get the master light point drawable that is used to draw all the light points.

virtual bool makVrv::DtOsgLightPointManager::debugLabelsEnabled ( ) const

virtual

Check to see if debug labels are enabled. They are controlled by the imGui debug Gui.

virtual bool makVrv::DtOsgLightPointManager::debugDirectionEnabled ( ) const

virtual

Check to see if debug direcion light points should be drawn.

virtual bool makVrv::DtOsgLightPointManager::softerLightPointsEnabled ( ) const

virtual

Check to see if soften light points is enabled.

virtual float makVrv::DtOsgLightPointManager::softenIntensity ( ) const

virtual

Get the intensity of the softening for the light points.

virtual void makVrv::DtOsgLightPointManager::setShouldReplaceOsgSimLightPoints ( bool enable )

virtual

Set if the light point manager should replace osgSim light point nodes with DtLightPointNodes this defaults to false for now and is controlled by an environment variable in the managers contructor.

virtual bool makVrv::DtOsgLightPointManager::shouldReplaceOsgSimLightPoints ( )

virtual

Get if the light point manager should replace osgSim light point nodes with DtLightPointNodes this defaults to false for now and is controlled by an environment variable in the managers contructor.

virtual void makVrv::DtOsgLightPointManager::freeNodeIds ( std::vector< int > & nodeIds )

virtual

When a DtLightPointNode is deleted it calls this in order to free up the nodeIds.

virtual void makVrv::DtOsgLightPointManager::releaseGLObjects ( osg::State * state ) const

virtual

virtual void makVrv::DtOsgLightPointManager::setInstanceReflectionMatrix	(	const osg::Camera *	camera,
		const osg::Matrixf &	reflectMat
	)

virtual

sets up the reflection pass matrix that converts from the main camera view space to the reflection camera view space.

virtual const osg::Matrixf& makVrv::DtOsgLightPointManager::instanceReflectionMatrix ( const osg::Camera * camera )

virtual

gets the reflection pass matrix that converts from the main camera view space to the reflection camera view space.

virtual bool makVrv::DtOsgLightPointManager::entityInstanceGroupInformation	(	const std::string &	modelDefinitionName,
		const std::string &	entityInstanceName,
		int &	firstGroupId,
		int &	numberOfLightPointGroups
	)

virtual

Get group information about a particular entity instance - returns true if successful, false otherwise.

virtual int makVrv::DtOsgLightPointManager::entitySubLightPointGroupIndex	(	const std::string &	modelDefinitionName,
		const std::string &	subLightPointGroupName
	)

virtual

Get the entity sub LightPoint group index.

virtual void makVrv::DtOsgLightPointManager::removeGroupsForEntityInstance	(	const std::string &	modelDefinitionName,
		const std::string &	entityInstanceName
	)

virtual

Remove all registered light point groups associated with the provided entity.

virtual int makVrv::DtOsgLightPointManager::registerNewEntityInstanceAndGetStartingGroupIdIndex	(	const std::string &	modelDefinitionName,
		const std::string &	entityInstanceName
	)

virtual

Register light point groups for an entity and return the starting index for the entity's light point properties.

virtual bool makVrv::DtOsgLightPointManager::drawLightPoints ( )

virtual

controlled by IMgui and is used to stop drawing/culling light points entirely.

virtual DtDebugLabelMode makVrv::DtOsgLightPointManager::debugLabelMode ( ) const

virtual

Get the type of debug label we will be visualizing.

virtual const std::string makVrv::DtOsgLightPointManager::searchNodeHierarchyForGroupName ( osg::Node * sourceNode ) const

virtual

look at the given node and it's parents to see if there is a group setup Currently supports light_group comments or runway wizard generated names

virtual void makVrv::DtOsgLightPointManager::slot_reloadShaders ( )

protectedvirtual

Handle the reload shaders signal and reload the shaders for the managed light points.

virtual void makVrv::DtOsgLightPointManager::setupShaders ( )

protectedvirtual

Reload the shaders and assign them to the drawables VP.

const std::string makVrv::DtOsgLightPointManager::parseNodeGroupName ( osg::Node * node ) const

protected

utility function for checking a node for the light_group comment.

virtual LightPointNodeObsSet makVrv::DtOsgLightPointManager::aggregateLightPoints	(	const DtLightPointNodeAndXformVector &	lightPoints,
		const DtLightPointRegistrationParameters &	params
	)

protectedvirtual

combine light points that can be combined into less nodes and convert them into DtLightPointNodes if needed as well.

virtual void makVrv::DtOsgLightPointManager::populateLightPointNode	(	osg::Node *	nodeRef,
		DtLightPointNode *	dtLpRef,
		bool	daylightControlled,
		bool	newNode
	)

protectedvirtual

Add incoming light points to an existing light point node.

virtual const std::string makVrv::DtOsgLightPointManager::specialCaseSearchForCreatorGeneratedRunwayGroups ( osg::Node * searchNode ) const

protectedvirtual

static void makVrv::DtOsgLightPointManager::cleanupNodes ( osg::Node * node )

staticprotected

Remove empty nodes, recursively upward in the graph. Some nodes are made empty by the light point aggregator, and are the only child of their parent, so can be removed, and so forth up into the graph.

Member Data Documentation

boost::signalslib::signal<void(LightPointNodeObsSet&)> makVrv::DtOsgLightPointManager::signal_lightPointsRegistered

Emitted when the terrain patch has light points added.

boost::signalslib::signal<void(DtDebugLabelMode)> makVrv::DtOsgLightPointManager::signal_debugLabelModeChanged

Emitted when the debug label moed has changed.

DtGlBuffer* makVrv::DtOsgLightPointManager::myLightPointTypeBuffer

protected

DtGlBuffer* makVrv::DtOsgLightPointManager::myLightPointGroupBuffer

protected

CameraVectorMap makVrv::DtOsgLightPointManager::myLightPointNodeDataMap

protected

DtGlBuffer* makVrv::DtOsgLightPointManager::myLightPointNodeBuffer

protected

DtGlBuffer* makVrv::DtOsgLightPointManager::myLightPointVertexBuffer

protected

NodeIdMap makVrv::DtOsgLightPointManager::myNodeIds

protected

std::set<int> makVrv::DtOsgLightPointManager::myFreeNodeIds

protected

boost::mutex makVrv::DtOsgLightPointManager::myMutex

protected

boost::mutex makVrv::DtOsgLightPointManager::myNodeIdMutex

protected

boost::recursive_mutex makVrv::DtOsgLightPointManager::myNodeBufferMutex

protected

boost::shared_mutex makVrv::DtOsgLightPointManager::myLightsTableMutex

protected

osg::ref_ptr<DtLightPointDrawable> makVrv::DtOsgLightPointManager::myMasterLightPointDrawable

protected

bool makVrv::DtOsgLightPointManager::myDebugLabelsEnabled

protected

DtDebugLabelMode makVrv::DtOsgLightPointManager::myDebugLabelMode

protected

bool makVrv::DtOsgLightPointManager::myDebugDirectionEnabled

protected

bool makVrv::DtOsgLightPointManager::myShouldReplaceOsgSimLightPoints

protected

bool makVrv::DtOsgLightPointManager::mySofterLightPointsEnabled

protected

float makVrv::DtOsgLightPointManager::mySoftenIntensity

protected

bool makVrv::DtOsgLightPointManager::myDrawLightPoints

protected

GroupIdMap makVrv::DtOsgLightPointManager::myImGuiProcessedGroupIds

protected

ParentGroupIdMap makVrv::DtOsgLightPointManager::myImGuiGroups

protected

DtSignalConnectionManager makVrv::DtOsgLightPointManager::myImGuiDisplayNameAttributeChangedConnection

protected

std::map<const osg::Camera*, osg::Matrixf> makVrv::DtOsgLightPointManager::myInstanceReflectionMatrix

protected

LightPointNodeObsSet makVrv::DtOsgLightPointManager::myLightPointNodes

protected

DtDe& makVrv::DtOsgLightPointManager::myDtDe

protected

The documentation for this class was generated from the following file:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvOsg/DtOsgLightPointManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation