VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
makVrv::DtMixedRealityMask Class Referenceabstract

Object to handle rendering a mixed reality mask object into the scene. More...

Inheritance diagram for makVrv::DtMixedRealityMask:
Inheritance graph
[legend]

Public Member Functions

 DtMixedRealityMask (DtDe &de)
 constructor More...
 
virtual ~DtMixedRealityMask ()
 DTOR. More...
 
virtual void initalizeMaskingObect (osg::Group *mountTo, osg::Vec3 offset, bool followObserver, std::string modelFile)
 initalise the mask object by setting the offset, clearing any exisiting children then calling the provider specific implementation More...
 
virtual void startMasking ()
 start masking by attaching the node to the scene and enabling our callbacks More...
 
virtual void stopMasking ()
 stop masking by dettaching the node from the scene and disabling our callbacks More...
 
virtual void setOffset (const osg::Vec3 &offset)
 set the translation of the offset transform matrix More...
 
virtual float nearDepthRange () const
 returns the near depth range for depth testing MR More...
 
virtual void nearDepthRange (float nearDepth)
 set the far depth range for depth testing MR More...
 
virtual float farDepthRange () const
 returns the near depth range for depth testing MR More...
 
virtual void farDepthRange (float farDepth)
 set the far depth range for depth testing MR More...
 
virtual void slot_onPostUpdate ()
 post update event for syncing model with observer position if required More...
 

Protected Member Functions

virtual void initalizeMaskingObectImplementation (std::string modelFile)=0
 provider specific implementation of object initalization, objects should be attached to the offset transform, when this function is called all object transform children will have been removed More...
 
DtSceneObjectfindSceneObjectFromElement (const DtElementID &id, int modelSet)
 find scene object, used to find the observer attached objects More...
 

Protected Attributes

DtDemyDe
 
DtVirtualRealityDrivermyDriverHandle
 
DtSignalConnectionManager myConnections
 
bool myMaskingActive
 
osg::ref_ptr< osg::Group > myMountNode
 
osg::Vec3 myMaskNodeOffset
 
bool myShouldFollowObserver
 
bool myUseAttachmentPosition
 
float myNearDpethRange
 
float myFarDepthRange
 
osg::ref_ptr
< osg::MatrixTransform > 
myOffsetTransform
 
osg::ref_ptr
< osg::MatrixTransform > 
myMixedRealityMaskNode
 

Private Member Functions

 DtMixedRealityMask (const DtMixedRealityMask &other)
 Copy Constructor not implemented – Copy Not Allowed. More...
 
DtMixedRealityMaskoperator= (const DtMixedRealityMask &other)
 Assignment Operator Not implemented – Assignment Not Allowed. More...
 

Detailed Description

Object to handle rendering a mixed reality mask object into the scene.

Typically the it renders an object to the alpha channel only to allow a video feed to be rendered in the transparent areas

Constructor & Destructor Documentation

makVrv::DtMixedRealityMask::DtMixedRealityMask ( const DtMixedRealityMask other)
private

Copy Constructor not implemented – Copy Not Allowed.

makVrv::DtMixedRealityMask::DtMixedRealityMask ( DtDe de)

constructor

virtual makVrv::DtMixedRealityMask::~DtMixedRealityMask ( )
virtual

DTOR.

Member Function Documentation

DtMixedRealityMask& makVrv::DtMixedRealityMask::operator= ( const DtMixedRealityMask other)
private

Assignment Operator Not implemented – Assignment Not Allowed.

virtual void makVrv::DtMixedRealityMask::initalizeMaskingObect ( osg::Group *  mountTo,
osg::Vec3  offset,
bool  followObserver,
std::string  modelFile 
)
virtual

initalise the mask object by setting the offset, clearing any exisiting children then calling the provider specific implementation

virtual void makVrv::DtMixedRealityMask::startMasking ( )
virtual

start masking by attaching the node to the scene and enabling our callbacks

virtual void makVrv::DtMixedRealityMask::stopMasking ( )
virtual

stop masking by dettaching the node from the scene and disabling our callbacks

virtual void makVrv::DtMixedRealityMask::setOffset ( const osg::Vec3 &  offset)
virtual

set the translation of the offset transform matrix

virtual float makVrv::DtMixedRealityMask::nearDepthRange ( ) const
virtual

returns the near depth range for depth testing MR

virtual void makVrv::DtMixedRealityMask::nearDepthRange ( float  nearDepth)
virtual

set the far depth range for depth testing MR

virtual float makVrv::DtMixedRealityMask::farDepthRange ( ) const
virtual

returns the near depth range for depth testing MR

virtual void makVrv::DtMixedRealityMask::farDepthRange ( float  farDepth)
virtual

set the far depth range for depth testing MR

virtual void makVrv::DtMixedRealityMask::slot_onPostUpdate ( )
virtual

post update event for syncing model with observer position if required

virtual void makVrv::DtMixedRealityMask::initalizeMaskingObectImplementation ( std::string  modelFile)
protectedpure virtual

provider specific implementation of object initalization, objects should be attached to the offset transform, when this function is called all object transform children will have been removed

Implemented in makVrv::DtVarjoMixedRealityMask.

DtSceneObject* makVrv::DtMixedRealityMask::findSceneObjectFromElement ( const DtElementID id,
int  modelSet 
)
protected

find scene object, used to find the observer attached objects

Member Data Documentation

DtDe& makVrv::DtMixedRealityMask::myDe
protected
DtVirtualRealityDriver* makVrv::DtMixedRealityMask::myDriverHandle
protected
DtSignalConnectionManager makVrv::DtMixedRealityMask::myConnections
protected
bool makVrv::DtMixedRealityMask::myMaskingActive
protected
osg::ref_ptr<osg::Group> makVrv::DtMixedRealityMask::myMountNode
protected
osg::Vec3 makVrv::DtMixedRealityMask::myMaskNodeOffset
protected
bool makVrv::DtMixedRealityMask::myShouldFollowObserver
protected
bool makVrv::DtMixedRealityMask::myUseAttachmentPosition
protected
float makVrv::DtMixedRealityMask::myNearDpethRange
protected
float makVrv::DtMixedRealityMask::myFarDepthRange
protected
osg::ref_ptr<osg::MatrixTransform> makVrv::DtMixedRealityMask::myOffsetTransform
protected
osg::ref_ptr<osg::MatrixTransform> makVrv::DtMixedRealityMask::myMixedRealityMaskNode
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)