FormIt C++ API  v23.0.0 (2023.0.0)
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 ()
 
void setDefault ()
 
void ensureSizeAndCornersAreCorrect ()
 

Public Attributes

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

Static Public Attributes

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

Constructor & Destructor Documentation

FORMIT_CORE_EXPORT FormIt::ImageData::ImageData ( )

Member Function Documentation

void FormIt::ImageData::ensureSizeAndCornersAreCorrect ( )
void FormIt::ImageData::setDefault ( )

Member Data Documentation

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

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

float FormIt::ImageData::mAlphaLevel

Alpha level for given image object.

WSM::Vector2d FormIt::ImageData::mCoordinates

(Lat, Lon)

WSM::Vector2d FormIt::ImageData::mCoordinatesSpan

(LatSpan, LonSpan)

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

Geometric data for the image.

bool FormIt::ImageData::mIsFeaturesVisible

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

bool FormIt::ImageData::mIsSatelliteImage

Satellite data:

::string FormIt::ImageData::mName

Image name.

WSM::Vector2d FormIt::ImageData::mOriginOffset

offset of the image object

::string FormIt::ImageData::mPath

Texture path for image object.

WSM::Vector2d FormIt::ImageData::mSize

Image size.

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

Satellite image dimensions.

size_t FormIt::ImageData::mTextureId

Texture id for image object (WSM)

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: