Workspace 6.21.5
Public Member Functions | List of all members
SceneOverlay Class Reference

Specialization of DataAnalysis::ImageOverlay for use as an overlay on a rendered scene.

#include <Rendering/SceneComponents/sceneoverlay.h>

Inheritance diagram for SceneOverlay:
[legend]

Public Member Functions

 SceneOverlay ()
 
 SceneOverlay (const DataAnalysis::ImageOverlay &overlay)
 
 SceneOverlay (const SceneOverlay &overlay)
 
 ~SceneOverlay () override
 
void clearCameraNames ()
 
SceneOverlay * clone () const override
 
QStringList getCameraNames () const
 
bool getEnabled () const
 
SceneOverlay & operator= (const SceneOverlay &overlay)
 
void setCameraNames (const QStringList &names)
 
void setEnabled (bool b)
 
- Public Member Functions inherited from ImageOverlay
 ImageOverlay ()
 
 ImageOverlay (const ImageOverlay &overlay)
 
 ~ImageOverlay () override
 
ImageOverlay * clone () const override
 
Anchor getAnchor () const
 
const QImage & getImage () const
 
int getOffsetX () const
 
int getOffsetY () const
 
double getOpacity () const
 
QPoint getPlacement (int width, int height) const
 
ImageOverlay & operator= (const ImageOverlay &overlay)
 
void setAnchor (Anchor anchor)
 
void setImage (const QImage &image)
 
void setOffsetX (int x)
 
void setOffsetY (int y)
 
void setOpacity (double opacity)
 
- Public Member Functions inherited from ObjectGroup
 ~ObjectGroup () override
 
bool add (const QString &name, DataObject &obj)
 
bool canSerialize () const override
 
ObjectGroup * clone () const override=0
 
bool empty () const
 
void ensureGroupHasData ()
 
void erase (int index)
 
DataObject * getChild (const QString &name)
 
const DataObject * getChild (const QString &name) const
 
DataObject & getDataObject (int index)
 
const DataObject & getDataObject (int index) const
 
int getIndex (const QString &name) const
 
const QString & getName (int index) const
 
virtual QString getPreferedWidget (const QString &name) const
 
bool hasData () const
 
bool haveName (const QString &name) const
 
bool insert (const QString &name, DataObject &obj, int index=-1)
 
bool load (const QJsonDocument &doc)
 
bool load (const SerializedItem &item) override
 
bool save (QJsonDocument &doc) const
 
bool save (SerializedItem &item) const override
 
unsigned size () const
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()=default
 
virtual Clonable * clone () const =0
 
- Public Member Functions inherited from Serialize
virtual ~Serialize ()=default
 
virtual bool canSerialize () const =0
 
virtual bool load (const SerializedItem &item)=0
 
virtual bool save (SerializedItem &item) const =0
 

Additional Inherited Members

- Public Types inherited from ImageOverlay
enum  Anchor {
  TopLeft , TopCenter , TopRight , CenterLeft ,
  Center , CenterRight , BottomLeft , BottomCenter ,
  BottomRight , Tiled
}
 
- Protected Member Functions inherited from ObjectGroup
 ObjectGroup ()
 
void clear ()
 
ObjectGroup & operator= (const ObjectGroup &rhs)
 
bool operator== (const ObjectGroup &rhs) const
 
void swap (ObjectGroup &rhs)
 

Constructor & Destructor Documentation

◆ SceneOverlay() [1/3]

SceneOverlay ( )

◆ SceneOverlay() [2/3]

SceneOverlay ( const SceneOverlay &  overlay)
Parameters
overlayThe scene overlay item to be copied.

◆ SceneOverlay() [3/3]

SceneOverlay ( const DataAnalysis::ImageOverlay &  overlay)
Parameters
overlayThe image overlay item to be copied.

When created with this constructor, the scene overlay will have an empty list of camera names and will be enabled by default.

◆ ~SceneOverlay()

~SceneOverlay ( )
override

Member Function Documentation

◆ clearCameraNames()

void clearCameraNames ( )

Clears the list of camera names this scene overlay item is associated with. This will make it apply to all cameras.

See also
getCameraNames(), setCameraNames()

◆ clone()

SceneOverlay * clone ( ) const
overridevirtual
Returns
A clone of this object.
Note
Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

We redeclare this function only so that the more derived return type is available without casting.

Reimplemented from ImageOverlay.

◆ getCameraNames()

QStringList getCameraNames ( ) const
Returns
The list of camera names for which this scene overlay item should be shown.
See also
setCameraNames(), clearCameraNames()

◆ getEnabled()

bool getEnabled ( ) const
Returns
True if this scene overlay item is enabled, meaning that it should be processed by scene processors.

When a scene overlay item is not enabled, all scene processors must ignore it as though it was not even present. Items are enabled by default.

See also
setEnabled()

◆ operator=()

SceneOverlay & operator= ( const SceneOverlay &  overlay)
Parameters
overlayThe scene overlay item to be copied.

◆ setCameraNames()

void setCameraNames ( const QStringList &  names)
Parameters
namesThe list of camera names for which this scene overlay item should be shown. If the list is empty, it will be shown for all cameras.
See also
getCameraNames(), clearCameraNames()

◆ setEnabled()

void setEnabled ( bool  b)
Parameters
bSpecifies whether or not this particular scene overlay item should be processed by scene processors.

When a scene overlay item is not enabled, all scene processors must ignore it as though it was not even present. Items are enabled by default.

See also
getEnabled()