FormIt C++ API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
FormIt::ImageData Class Reference

Description

Class that represents an image object implements code to have the different data members loaded correctly i.e.: create corners using size, calculate size using corners, etc.

#include <FormItCoreTypes.h>

Public Member Functions

FORMIT_CORE_EXPORT ImageData ()
 ImageData() function.
 
void setDefault ()
 setDefault() function.
 
void ensureSizeAndCornersAreCorrect ()
 ensureSizeAndCornersAreCorrect() function.
 

Public Attributes

::string mName
 Image name.
 
::string mPath
 Texture path for image object.
 
size_t mTextureId
 Texture id for image object (WSM)
 
float mAlphaLevel
 Alpha level for given image object.
 
size_t mZPosition
 Indicates the order that the images must be rendered.
 
::array< WSM::Point3d, 4 > mCorners
 Geometric data for the image.
 
WSM::Vector2d mSize
 Image size.
 
bool mIsSatelliteImage
 Satellite data:
 
WSM::Vector2d mCoordinates
 (Lat, Lon)
 
WSM::Vector2d mCoordinatesSpan
 (LatSpan, LonSpan)
 
::array< size_t, 2 > mSizeInPixels
 Satellite image dimensions.
 
bool mIsFeaturesVisible
 Image features extracted from image - lines, arcs, etc.
 
WSM::Vector2d mOriginOffset
 offset of the image object
 

Static Public Attributes

static const ::string kImagePlaceholder
 Name of the placeholder image for when the actual image is not yet present.
 

Constructor & Destructor Documentation

◆ ImageData()

FORMIT_CORE_EXPORT FormIt::ImageData::ImageData ( )

ImageData() function.

Member Function Documentation

◆ ensureSizeAndCornersAreCorrect()

void FormIt::ImageData::ensureSizeAndCornersAreCorrect ( )

◆ setDefault()

void FormIt::ImageData::setDefault ( )

setDefault() function.

Member Data Documentation

◆ kImagePlaceholder

const ::string FormIt::ImageData::kImagePlaceholder
static

Name of the placeholder image for when the actual image is not yet present.

◆ mAlphaLevel

float FormIt::ImageData::mAlphaLevel

Alpha level for given image object.

◆ mCoordinates

WSM::Vector2d FormIt::ImageData::mCoordinates

(Lat, Lon)

◆ mCoordinatesSpan

WSM::Vector2d FormIt::ImageData::mCoordinatesSpan

(LatSpan, LonSpan)

◆ mCorners

::array<WSM::Point3d, 4> FormIt::ImageData::mCorners

Geometric data for the image.

◆ mIsFeaturesVisible

bool FormIt::ImageData::mIsFeaturesVisible

Image features extracted from image - lines, arcs, etc.

◆ mIsSatelliteImage

bool FormIt::ImageData::mIsSatelliteImage

Satellite data:

◆ mName

::string FormIt::ImageData::mName

Image name.

◆ mOriginOffset

WSM::Vector2d FormIt::ImageData::mOriginOffset

offset of the image object

◆ mPath

::string FormIt::ImageData::mPath

Texture path for image object.

◆ mSize

WSM::Vector2d FormIt::ImageData::mSize

Image size.

◆ mSizeInPixels

::array<size_t, 2> FormIt::ImageData::mSizeInPixels

Satellite image dimensions.

◆ mTextureId

size_t FormIt::ImageData::mTextureId

Texture id for image object (WSM)

◆ mZPosition

size_t FormIt::ImageData::mZPosition

Indicates the order that the images must be rendered.


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