cesium-native  0.41.0
Classes | Public Member Functions | List of all members
CesiumUtility::CreditSystem Class Referencefinal

Creates and manages Credit objects. Avoids repetitions and tracks which credits should be shown and which credits should be removed this frame. More...

#include <CesiumUtility/CreditSystem.h>

Public Member Functions

Credit createCredit (std::string &&html, bool showOnScreen=false)
 Inserts a credit string. More...
 
Credit createCredit (const std::string &html, bool showOnScreen=false)
 Inserts a credit string. More...
 
bool shouldBeShownOnScreen (Credit credit) const noexcept
 Gets whether or not the credit should be shown on screen.
 
void setShowOnScreen (Credit credit, bool showOnScreen) noexcept
 Sets whether or not the credit should be shown on screen.
 
const std::string & getHtml (Credit credit) const noexcept
 Get the HTML string for this credit.
 
void addCreditToFrame (Credit credit)
 Adds the Credit to the set of credits to show this frame.
 
void startNextFrame () noexcept
 Notifies this CreditSystem to start tracking the credits to show for the next frame.
 
const std::vector< Credit > & getCreditsToShowThisFrame () noexcept
 Get the credits to show this frame.
 
const std::vector< Credit > & getCreditsToNoLongerShowThisFrame () const noexcept
 Get the credits that were shown last frame but should no longer be shown.
 

Detailed Description

Creates and manages Credit objects. Avoids repetitions and tracks which credits should be shown and which credits should be removed this frame.

Definition at line 39 of file CreditSystem.h.

Member Function Documentation

◆ createCredit() [1/2]

Credit CesiumUtility::CreditSystem::createCredit ( const std::string &  html,
bool  showOnScreen = false 
)

Inserts a credit string.

Returns
If this string already exists, returns a Credit handle to the existing entry. Otherwise returns a Credit handle to a new entry.

◆ createCredit() [2/2]

Credit CesiumUtility::CreditSystem::createCredit ( std::string &&  html,
bool  showOnScreen = false 
)

Inserts a credit string.

Returns
If this string already exists, returns a Credit handle to the existing entry. Otherwise returns a Credit handle to a new entry.
The documentation for this class was generated from the following file: