SimpleFovExporter

Search for usage in LXR

#include <simplefovexporter.h>

Public Member Functions

 SimpleFovExporter ()
 
void exportFov (const QList< SkyPoint * > &points, const QList< FOV * > &fovs, const QList< QPaintDevice * > &pds)
 
void exportFov (const QList< SkyPoint * > &points, FOV *fov, const QList< QPaintDevice * > &pds)
 
void exportFov (FOV *fov, QPaintDevice *pd)
 
void exportFov (QPaintDevice *pd)
 
void exportFov (SkyPoint *point, FOV *fov, QPaintDevice *pd)
 
bool isClockStopping () const
 
bool isFovShapeOverriden () const
 
bool isFovSymbolDrawn () const
 
void setClockStopping (bool stopping)
 
void setFovShapeOverriden (bool overrideFovShape)
 
void setFovSymbolDrawn (bool draw)
 

Static Public Member Functions

static double calculatePixelSize (float degrees, double zoomLevel)
 
static double calculateZoomLevel (int pixelSize, float degrees)
 

Detailed Description

SimpleFovExporter class is used for FOV representation exporting. Central point is defined by passed pointer to SkyPoint instance and field-of-view parameters are defined by FOV class instance. Fragment of sky is painted on passed QPaintDevice subclass. SimpleFovExporter class can be used for export of FOV representations in user-interactive mode as well as for export of multiple FOVs at once, without user interaction.

Note
Please note that SimpleFovExporter class instances may pause simulation clock if they're configured to do so (via setClockStopping() method).
FOV representation's shape can be overridden (i.e. FOV image will be always rectangular) using setFovShapeOverriden() method.

Definition at line 30 of file simplefovexporter.h.

Constructor & Destructor Documentation

◆ SimpleFovExporter()

SimpleFovExporter::SimpleFovExporter ( )

Constructor.

Definition at line 17 of file simplefovexporter.cpp.

Member Function Documentation

◆ calculatePixelSize()

static double SimpleFovExporter::calculatePixelSize ( float  degrees,
double  zoomLevel 
)
inlinestatic

Calculate pixel size of given angular length at given zoom level.

Parameters
degreesangular length.
zoomLevelzoom level.
Returns
size in pixels.

Definition at line 126 of file simplefovexporter.h.

◆ calculateZoomLevel()

static double SimpleFovExporter::calculateZoomLevel ( int  pixelSize,
float  degrees 
)
inlinestatic

Calculate zoom level at which given angular length will occupy given length in pixels.

Parameters
pixelSizesize in pixels.
degreesangular length.
Returns
zoom level.

Definition at line 118 of file simplefovexporter.h.

◆ exportFov() [1/5]

void SimpleFovExporter::exportFov ( const QList< SkyPoint * > &  points,
const QList< FOV * > &  fovs,
const QList< QPaintDevice * > &  pds 
)

Export multiple FOV representations.

Parameters
pointslist of central points.
fovslist of fields-of-view.
pdslist of paint devices on which the representation of the FOV will be painted.

Definition at line 51 of file simplefovexporter.cpp.

◆ exportFov() [2/5]

void SimpleFovExporter::exportFov ( const QList< SkyPoint * > &  points,
FOV fov,
const QList< QPaintDevice * > &  pds 
)

Export multiple FOV representations.

Parameters
pointslist of central points.
fovlist of fields-of-view.
pdslist of paint devices on which the representation of the FOV will be painted.

Definition at line 66 of file simplefovexporter.cpp.

◆ exportFov() [3/5]

void SimpleFovExporter::exportFov ( FOV fov,
QPaintDevice pd 
)

Paint FOV representation on passed QPaintDevice subclass.

Parameters
fovrepresented field-of-view.
pdpaint device on which the representation of the FOV will be painted.

Definition at line 30 of file simplefovexporter.cpp.

◆ exportFov() [4/5]

void SimpleFovExporter::exportFov ( QPaintDevice pd)

Paint FOV representation on passed QPaintDevice subclass.

Parameters
pdpaint device on which the representation of the FOV will be painted.

Definition at line 35 of file simplefovexporter.cpp.

◆ exportFov() [5/5]

void SimpleFovExporter::exportFov ( SkyPoint point,
FOV fov,
QPaintDevice pd 
)

Paint FOV representation on passed QPaintDevice subclass.

Parameters
pointcentral point of the exported FOV.
fovrepresented field-of-view.
pdpaint device on which the representation of the FOV will be painted.

Definition at line 23 of file simplefovexporter.cpp.

◆ isClockStopping()

bool SimpleFovExporter::isClockStopping ( ) const
inline

Check if FOV export will cause simulation clock to be stopped.

Returns
true if clock will be stopped for FOV export.
Note
If changed, previous clock state will be restored after FOV export is done.

Definition at line 80 of file simplefovexporter.h.

◆ isFovShapeOverriden()

bool SimpleFovExporter::isFovShapeOverriden ( ) const
inline

Check if FOV representation will be always rectangular.

Returns
true if FOV shape is overridden.

Definition at line 86 of file simplefovexporter.h.

◆ isFovSymbolDrawn()

bool SimpleFovExporter::isFovSymbolDrawn ( ) const
inline

Check if FOV symbol will be drawn.

Returns
true if FOV symbol will be drawn.

Definition at line 92 of file simplefovexporter.h.

◆ setClockStopping()

void SimpleFovExporter::setClockStopping ( bool  stopping)
inline

Enable or disable stopping simulation for FOV export.

Parameters
stoppingshould be true if stopping is to be enabled.

Definition at line 98 of file simplefovexporter.h.

◆ setFovShapeOverriden()

void SimpleFovExporter::setFovShapeOverriden ( bool  overrideFovShape)
inline

Enable or disable FOV shape overriding.

Parameters
overrideFovShapeshould be true if FOV representation is to be always rectangular.

Definition at line 104 of file simplefovexporter.h.

◆ setFovSymbolDrawn()

void SimpleFovExporter::setFovSymbolDrawn ( bool  draw)
inline

Enable or disable FOV symbol drawing.

Parameters
drawshould be true if FOV symbol is to be drawn.

Definition at line 110 of file simplefovexporter.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Tue Aug 9 2022 04:06:11 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.