Ignition Gazebo

API Reference

6.0.0~pre1
ComponentInspector.hh File Reference
#include <map>
#include <memory>
#include <string>
#include <sdf/Physics.hh>
#include <ignition/math/Pose3.hh>
#include <ignition/math/Vector3.hh>
#include <ignition/gazebo/components/Component.hh>
#include <ignition/gazebo/gui/GuiSystem.hh>
#include <ignition/gazebo/Types.hh>
#include <ignition/msgs/light.pb.h>

Go to the source code of this file.

Functions

 Q_DECLARE_METATYPE (ComponentTypeId) namespace ignition
 

Function Documentation

◆ Q_DECLARE_METATYPE()

Q_DECLARE_METATYPE ( ComponentTypeId  )

Generic function to set data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set string data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set pose data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set light data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set vector data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set Physics data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set Spherical Coordinates data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set boolean data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set integer data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set double data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Specialized to set stream data.

Parameters
[in]_itemItem whose data will be set.
[in]_dataData to set.

Set the unit of a given item.

Parameters
[in]_itemItem whose unit will be set.
[in]_unitUnit to be displayed, such as 'm' for meters.

Model holding information about components, such as their type and data.

Constructor

Destructor

Static version of roleNames

Returns
A hash connecting a unique identifier to a role name.

Add a component type to the inspector.

Parameters
[in]_typeIdType of component to be added.
Returns
Newly created item.

Remove a component type from the inspector.

Parameters
[in]_typeIdType of component to be removed.

Keep track of items in the tree, according to type ID.

Displays a tree view with all the entities in the world.

Configuration

None

Entity

Type

Locked

Paused

Nested Model

Constructor

Destructor

Callback in Qt thread when pose changes.

Parameters
[in]_xX
[in]_yY
[in]_zZ
[in]_rollRoll
[in]_pitchPitch
[in]_yawYaw

Callback in Qt thread when specular changes.

Parameters
[in]_rSpecularspecular red
[in]_gSpecularspecular green
[in]_bSpecularspecular blue
[in]_aSpecularspecular alpha
[in]_rDiffuseDiffuse red
[in]_gDiffuseDiffuse green
[in]_bDiffuseDiffuse blue
[in]_aDiffuseDiffuse alpha
[in]_attRangeRange attenuation
[in]_attLinearLinear attenuation
[in]_attConstantConstant attenuation
[in]_attQuadraticQuadratic attenuation
[in]_castShadowsSpecify if this light should cast shadows
[in]_directionXX direction of the light
[in]_directionYY direction of the light
[in]_directionZZ direction of the light
[in]_innerAngleInner angle of the spotlight
[in]_outerAngleOuter angle of the spotlight
[in]_falloffFalloff of the spotlight
[in]_intensityIntensity of the light
[in]_typelight type

Callback in Qt thread when physics' properties change.

Parameters
[in]_stepSizestep size
[in]_realTimeFactorreal time factor

Callback in Qt thread when spherical coordinates change.

Parameters
[in]_surfaceSurface model
[in]_latitudeLatitude in degrees
[in]_longitudeLongitude in degrees
[in]_elevationElevation in meters
[in]_headingHeading in degrees

Get whether the entity is a nested model or not

Returns
True if the entity is a nested model, false otherwise

Notify that is nested model property has changed

Get the entity currently inspected.

Returns
Entity ID.

Set the entity currently inspected.

Parameters
[in]_entityEntity ID.

Notify that entity has changed.

Get the type of entity currently inspected.

Returns
Type, such as 'world' or 'model'

Set the type of entity currently inspected.

Parameters
[in]_typeType, such as 'world' or 'model'.

Notify that entity type has changed

Get whether the inspector is currently locked on an entity.

Returns
True for locked

Set whether the inspector is currently locked on an entity.

Parameters
[in]_lockedTrue for locked.

Notify that locked has changed.

Get whether the inspector is currently paused for updates.

Returns
True for paused.

Set whether the inspector is currently paused for updates.

Parameters
[in]_pausedTrue for paused.

Notify that paused has changed.

References std::endl(), ignwarn, stringstream::str(), and IsOutStreamable< Stream, DataType >::value.