QSkyboxEntity Class | Qt 3D 5.6

Qt 5.6 | Qt 3D | C++ Classes | QSkyboxEntity

Qt 5.6.2 Reference Documentation

# QSkyboxEntity Class

(Qt3DRender::QSkyboxEntity)

Qt3DRender::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene. More...

Header: | #include <QSkyboxEntity>
qmake: | QT += 3drender
Since: | Qt 5.5
Inherits: | Qt3DCore::QEntity

- List of all members, including inherited members

## Public Functions

| QSkyboxEntity(Qt3DCore::QNode *parent = Q_NULLPTR)
| ~QSkyboxEntity()
QString | baseName() const
QVector3D | cameraPosition() const
QString | extension() const
void | setBaseName(const QString &baseName)
void | setCameraPosition(const QVector3D &cameraPosition)
void | setExtension(const QString &extension)

- 5 public functions inherited from Qt3DCore::QEntity
- 6 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject

## Signals

void | cameraPositionChanged(const QVector3D &cameraPosition)
void | extensionChanged(const QString &extension)
void | sourceDirectoryChanged(const QString &path)

- 2 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject

### Additional Inherited Members

- 2 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject
- 2 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 1 protected function inherited from Qt3DCore::QEntity
- 3 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject
- 1 static protected member inherited from Qt3DCore::QNode

## Detailed Description

Qt3DRender::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene.

By specifying a base name and an extension, Qt3DCore::QSkyboxEntity will take care of building a TextureCubeMap to be rendered at runtime. The images in the source directory should match the pattern: base name + * "_posx|_posy|_posz|_negx|_negy|_negz" + extension

By default the extension defaults to .png.

Note: Please note that you shouldn't try to render skybox with an orthographic projection.

## Member Function Documentation

### QSkyboxEntity::QSkyboxEntity(Qt3DCore::QNode *parent = Q_NULLPTR)

Default constructs an instance of QSkyboxEntity.

### QSkyboxEntity::~QSkyboxEntity()

Destroys the instance of QSkyboxEntity.

### QString QSkyboxEntity::baseName() const

Returns the base name.

See also setBaseName().

### QVector3D QSkyboxEntity::cameraPosition() const

Returns the camera postion.

See also setCameraPosition().

### `[signal]` void QSkyboxEntity::cameraPositionChanged(const QVector3D &cameraPosition)

### QString QSkyboxEntity::extension() const

Returns the extension

See also setExtension().

### `[signal]` void QSkyboxEntity::extensionChanged(const QString &extension)

### void QSkyboxEntity::setBaseName(const QString &baseName)

Sets the base name to baseName.

See also baseName().

### void QSkyboxEntity::setCameraPosition(const QVector3D &cameraPosition)

Sets the camera position to cameraPosition.

See also cameraPosition().

### void QSkyboxEntity::setExtension(const QString &extension)

Sets the extension to extension.

See also extension().

### `[signal]` void QSkyboxEntity::sourceDirectoryChanged(const QString &path)