Ignition Gazebo

API Reference

6.0.0~pre1
Display Struct Reference

Data used by the DisplayData() function to filter and sort the resources to be displayed. More...

#include <ResourceSpawner.hh>

Public Attributes

bool isFuel = false
 True if the user is currently observing fuel resources and false if the user is currently observing local resources. More...
 
std::string ownerPath = ""
 The name of the owner if the user has Fuel resources chosen, and the name of the local path if the user has local resources chosen. More...
 
std::string searchKeyword = ""
 The currently entered keyword that the user wants to search, empty if there is currently no search query. More...
 
std::string sortMethod = ""
 The currently chosen method of sorting, which includes "A - Z", "Z - A", "Most Recent", and "Downloaded." The default sort method is "Most Recent" as that is the order the fuel models are initially loaded. More...
 

Detailed Description

Data used by the DisplayData() function to filter and sort the resources to be displayed.

Member Data Documentation

◆ isFuel

bool isFuel = false

True if the user is currently observing fuel resources and false if the user is currently observing local resources.

◆ ownerPath

std::string ownerPath = ""

The name of the owner if the user has Fuel resources chosen, and the name of the local path if the user has local resources chosen.

◆ searchKeyword

std::string searchKeyword = ""

The currently entered keyword that the user wants to search, empty if there is currently no search query.

◆ sortMethod

std::string sortMethod = ""

The currently chosen method of sorting, which includes "A - Z", "Z - A", "Most Recent", and "Downloaded." The default sort method is "Most Recent" as that is the order the fuel models are initially loaded.


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