LuciadCPillar 2026.1
Loading...
Searching...
No Matches
luciad::SelectedProjection Class Reference

A projection to display, together with its blend weight. More...

#include <luciad/layers/projectedimagery/ProjectedImageryLayer.h>

Public Member Functions

 SelectedProjection (std::string id, double weight)
 Creates a selected projection.
const std::string & getId () const
 Returns the ID of the projection to display.
double getWeight () const
 Returns the blend weight.
bool operator== (const SelectedProjection &other) const =default
 Compares two selected projections for equality.

Detailed Description

A projection to display, together with its blend weight.

Several projections can be selected at once so that, for example, a navigation controller can cross-fade between them by animating the weights. The weight scales the whole projection: the effective opacity is the style opacity times the weight, and the effective sky opacity is the style sky opacity times the weight.

Since
2026.1

Constructor & Destructor Documentation

◆ SelectedProjection()

luciad::SelectedProjection::SelectedProjection ( std::string id,
double weight )

Creates a selected projection.

Parameters
idthe ID of the projection to display.
weightthe blend weight. Must be in the range [0, 1].
Exceptions
luciad::InvalidArgumentExceptionwhen weight < 0 or weight > 1.

Member Function Documentation

◆ getId()

const std::string & luciad::SelectedProjection::getId ( ) const
inline

Returns the ID of the projection to display.

Returns
the ID of the projection to display.

◆ getWeight()

double luciad::SelectedProjection::getWeight ( ) const
inline

Returns the blend weight.

Returns
the blend weight.

◆ operator==()

bool luciad::SelectedProjection::operator== ( const SelectedProjection & other) const
default

Compares two selected projections for equality.

Parameters
otherthe selected projection to compare with.
Returns
whether both have the same ID and weight.