Gazebo Gazebo

API Reference

6.16.0
ComponentInspectorEditor.hh File Reference
#include <map>
#include <memory>
#include <string>
#include <sdf/Material.hh>
#include <sdf/Physics.hh>
#include <sdf/Joint.hh>
#include <gz/math/Vector3.hh>
#include <gz/sim/components/Component.hh>
#include <gz/sim/gui/GuiSystem.hh>
#include <gz/sim/Types.hh>
#include <gz/msgs/light.pb.h>
#include "Types.hh"

Go to the source code of this file.

Functions

 Q_DECLARE_METATYPE (ignition::gazebo::ComponentTypeId) namespace ignition
 

Function Documentation

◆ Q_DECLARE_METATYPE()

Q_DECLARE_METATYPE ( ignition::gazebo::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 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.

Specialized to set material 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

Type

Type

Locked

Paused

Simulation paused

Nested Model

Constructor

Destructor

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
[in]_rAmbientambient red
[in]_gAmbientambient green
[in]_bAmbientambient blue
[in]_aAmbientambient alpha
[in]_rDiffusediffuse red
[in]_gDiffusediffuse green
[in]_bDiffusediffuse blue
[in]_aDiffusediffuse alpha
[in]_rSpecularspecular red
[in]_gSpecularspecular green
[in]_bSpecularspecular blue
[in]_aSpecularspecular alpha
[in]_rEmissiveemissive red
[in]_gEmissiveemissive green
[in]_bEmissiveemissive blue
[in]_aEmissiveemissive alpha
[in]_typeif type is not empty, opens QColorDialog. The possible types are ambient, diffuse, specular, or emissive.
[in]_currColorused for QColorDialog to show the current color in the open dialog.

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 simulation is currently paused.

Returns
True for paused.

Notify that simulation paused state has changed.

Set whether simulation is currently paused.

Parameters
[in]_pausedTrue for paused.

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.

Callback in Qt thread when an entity is to be added

Parameters
[in]_entityEntity to add, e.g. box, sphere, cylinder, etc
[in]_typeEntity type, e.g. link, visual, collision, etc

Callback in Qt thread when a joint is to be added

Parameters
[in]_jointTypeType of joint to add (revolute, fixed, etc)
[in]_parentLinkName of the link to be the parent link
[in]_childLinkName of the link to be the child link

Return the list of availabe links that are suitable for parent links in joints if a model is selected.

Returns
List of available links.

Return the list of availabe links that are suitable for child links in joints if a model is selected.

Returns
List of available links.

Set the list of availabe links when a model is selected.

Parameters
[in]_modelLinksList of available links.

Notify that locked has changed.

Callback to insert a new entity

Parameters
[in]_entityEntity to add, e.g. box, sphere, cylinder, etc
[in]_typeEntity type, e.g. link, visual, collision, etc
[in]_meshMesh file to load.

Add a callback that will be executed during the next Update.

Parameters
[in]_cbThe callback to run.

Register a component creator. A component creator is responsible for selecting the correct QML and setting the appropriate data for a ComponentTypeId.

Parameters
[in]_idThe component type id to associate with the creation function.
[in]_creatorFnFunction to call in order to create the QML component.

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