QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Types | Public Member Functions | List of all members
Qgs3DAxisSettings Class Reference

Contains the configuration of a 3d axis. More...

#include <qgs3daxissettings.h>

Public Types

enum class  Mode { Off = 1 , Crs = 2 , Cube = 3 }
 Axis representation enum. More...
 

Public Member Functions

 Qgs3DAxisSettings ()=default
 default constructor More...
 
 Qgs3DAxisSettings (const Qgs3DAxisSettings &other)
 copy constructor More...
 
int defaultViewportSize () const
 Returns the default axis viewport size in millimeters. More...
 
Qt::AnchorPoint horizontalPosition () const
 Returns the horizontal position for the 3d axis. More...
 
double maxViewportRatio () const
 Returns the maximal axis viewport ratio (see Qt3DRender::QViewport::normalizedRect()) More...
 
double minViewportRatio () const
 Returns the minimal axis viewport ratio (see Qt3DRender::QViewport::normalizedRect()) More...
 
Qgs3DAxisSettings::Mode mode () const
 Returns the type of the 3daxis. More...
 
bool operator!= (Qgs3DAxisSettings const &rhs) const
 Returns true if objects are not equal. More...
 
Qgs3DAxisSettingsoperator= (Qgs3DAxisSettings const &rhs)
 delete assignment operator More...
 
bool operator== (Qgs3DAxisSettings const &rhs) const
 Returns true if both objects are equal. More...
 
void readXml (const QDomElement &element, const QgsReadWriteContext &context)
 Reads settings from a DOM element. More...
 
void setDefaultViewportSize (int size)
 Sets the defaultl axis viewport size in millimeters. More...
 
void setHorizontalPosition (Qt::AnchorPoint position)
 Sets the horizontal position for the 3d axis. More...
 
void setMaxViewportRatio (double ratio)
 Sets the maximal axis viewport ratio between 0-1. More...
 
void setMinViewportRatio (double ratio)
 Sets the minimal axis viewport ratio between 0-1. More...
 
void setMode (Qgs3DAxisSettings::Mode type)
 Sets the type of the 3daxis. More...
 
void setVerticalPosition (Qt::AnchorPoint position)
 Sets the vertical position for the 3d axis. More...
 
Qt::AnchorPoint verticalPosition () const
 Returns the vertical position for the 3d axis. More...
 
void writeXml (QDomElement &element, const QgsReadWriteContext &context) const
 Writes settings to a DOM element. More...
 

Detailed Description

Contains the configuration of a 3d axis.

3

Since
QGIS 3.26

Definition at line 35 of file qgs3daxissettings.h.

Member Enumeration Documentation

◆ Mode

enum class Qgs3DAxisSettings::Mode
strong

Axis representation enum.

Enumerator
Off 

Hide 3d axis.

Crs 

Respect CRS directions.

Cube 

Abstract cube mode.

Definition at line 42 of file qgs3daxissettings.h.

Constructor & Destructor Documentation

◆ Qgs3DAxisSettings() [1/2]

Qgs3DAxisSettings::Qgs3DAxisSettings ( )
default

default constructor

◆ Qgs3DAxisSettings() [2/2]

Qgs3DAxisSettings::Qgs3DAxisSettings ( const Qgs3DAxisSettings other)

copy constructor

Definition at line 23 of file qgs3daxissettings.cpp.

Member Function Documentation

◆ defaultViewportSize()

int Qgs3DAxisSettings::defaultViewportSize ( ) const
inline

Returns the default axis viewport size in millimeters.

Definition at line 68 of file qgs3daxissettings.h.

◆ horizontalPosition()

Qt::AnchorPoint Qgs3DAxisSettings::horizontalPosition ( ) const
inline

Returns the horizontal position for the 3d axis.

Definition at line 88 of file qgs3daxissettings.h.

◆ maxViewportRatio()

double Qgs3DAxisSettings::maxViewportRatio ( ) const
inline

Returns the maximal axis viewport ratio (see Qt3DRender::QViewport::normalizedRect())

Definition at line 78 of file qgs3daxissettings.h.

◆ minViewportRatio()

double Qgs3DAxisSettings::minViewportRatio ( ) const
inline

Returns the minimal axis viewport ratio (see Qt3DRender::QViewport::normalizedRect())

Definition at line 73 of file qgs3daxissettings.h.

◆ mode()

Qgs3DAxisSettings::Mode Qgs3DAxisSettings::mode ( ) const
inline

Returns the type of the 3daxis.

Definition at line 83 of file qgs3daxissettings.h.

◆ operator!=()

bool Qgs3DAxisSettings::operator!= ( Qgs3DAxisSettings const &  rhs) const

Returns true if objects are not equal.

Definition at line 48 of file qgs3daxissettings.cpp.

◆ operator=()

Qgs3DAxisSettings & Qgs3DAxisSettings::operator= ( Qgs3DAxisSettings const &  rhs)

delete assignment operator

Definition at line 31 of file qgs3daxissettings.cpp.

◆ operator==()

bool Qgs3DAxisSettings::operator== ( Qgs3DAxisSettings const &  rhs) const

Returns true if both objects are equal.

Definition at line 39 of file qgs3daxissettings.cpp.

◆ readXml()

void Qgs3DAxisSettings::readXml ( const QDomElement &  element,
const QgsReadWriteContext context 
)

Reads settings from a DOM element.

Definition at line 53 of file qgs3daxissettings.cpp.

◆ setDefaultViewportSize()

void Qgs3DAxisSettings::setDefaultViewportSize ( int  size)
inline

Sets the defaultl axis viewport size in millimeters.

Definition at line 70 of file qgs3daxissettings.h.

◆ setHorizontalPosition()

void Qgs3DAxisSettings::setHorizontalPosition ( Qt::AnchorPoint  position)
inline

Sets the horizontal position for the 3d axis.

Definition at line 90 of file qgs3daxissettings.h.

◆ setMaxViewportRatio()

void Qgs3DAxisSettings::setMaxViewportRatio ( double  ratio)

Sets the maximal axis viewport ratio between 0-1.

Definition at line 161 of file qgs3daxissettings.cpp.

◆ setMinViewportRatio()

void Qgs3DAxisSettings::setMinViewportRatio ( double  ratio)

Sets the minimal axis viewport ratio between 0-1.

Definition at line 153 of file qgs3daxissettings.cpp.

◆ setMode()

void Qgs3DAxisSettings::setMode ( Qgs3DAxisSettings::Mode  type)
inline

Sets the type of the 3daxis.

Definition at line 85 of file qgs3daxissettings.h.

◆ setVerticalPosition()

void Qgs3DAxisSettings::setVerticalPosition ( Qt::AnchorPoint  position)
inline

Sets the vertical position for the 3d axis.

Definition at line 95 of file qgs3daxissettings.h.

◆ verticalPosition()

Qt::AnchorPoint Qgs3DAxisSettings::verticalPosition ( ) const
inline

Returns the vertical position for the 3d axis.

Definition at line 93 of file qgs3daxissettings.h.

◆ writeXml()

void Qgs3DAxisSettings::writeXml ( QDomElement &  element,
const QgsReadWriteContext context 
) const

Writes settings to a DOM element.

Definition at line 92 of file qgs3daxissettings.cpp.


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