Gazebo Gui

API Reference

8.3.0

Event that block the Interactive View control when some of the other plugins require it. For example: When the transform control is active we should block the movements of the camera. More...

#include <GuiEvents.hh>

Public Member Functions

 BlockOrbit (const bool &_block)
 Constructor. More...
 
bool Block () const
 Get the if the event should block the Interactive view controller. More...
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 12)
 Unique type for this event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QEvent
int registerEventType (int hint)
 
- Properties inherited from QEvent
 accepted
 

Detailed Description

Event that block the Interactive View control when some of the other plugins require it. For example: When the transform control is active we should block the movements of the camera.

Constructor & Destructor Documentation

◆ BlockOrbit()

BlockOrbit ( const bool &  _block)
explicit

Constructor.

Parameters
[in]_blockTrue to block otherwise False

Member Function Documentation

◆ Block()

bool Block ( ) const

Get the if the event should block the Interactive view controller.

Returns
True to block otherwise False.

Member Data Documentation

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 12)
static

Unique type for this event.


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