QClipPlane Class | Qt 3D 5.12.8

Qt 5.12 | Qt 3D | C++ Classes | QClipPlane

Qt 5.12.8 Reference Documentation

# QClipPlane Class

(Qt3DRender::QClipPlane)

Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance. More...

Header: | #include <QClipPlane>
qmake: | QT += 3drender
Since: | Qt 5.5
Instantiated By: | ClipPlane
Inherits: | Qt3DRender::QRenderState

- List of all members, including inherited members
- Obsolete members

## Properties

- distance : float
- normal : QVector3D
- planeIndex : int

- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject

## Public Functions

| QClipPlane(Qt3DCore::QNode *parent = nullptr)
float | distance() const
QVector3D | normal() const
int | planeIndex() const

- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject

## Public Slots

void | setDistance(float)
void | setNormal(QVector3D)
void | setPlaneIndex(int)

- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject

## Signals

void | distanceChanged(float distance)
void | normalChanged(QVector3D normal)
void | planeIndexChanged(int planeIndex)

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

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject

## Detailed Description

Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance.

By default, OpenGL supports up to 8 additional clipping planes. Qt3DCore::QClipPlane allows to enable one of these additional planes. These planes can then be manipulated in the shaders using gl_ClipDistance[i] where i varies between 0 and 7. The underlying implementation may support more than 8 clip planes, but it is not guaranteed.

## Property Documentation

### distance : float

Holds the distance of the plane from the world origin.

Access functions:

float | distance() const
void | setDistance(float)

Notifier signal:

void | distanceChanged(float distance)

### normal : QVector3D

Holds the normal of the plane.

Access functions:

QVector3D | normal() const
void | setNormal(QVector3D)

Notifier signal:

void | normalChanged(QVector3D normal)

### planeIndex : int

Holds the index of the plane.

Note: Usually between 0-7.

Access functions:

int | planeIndex() const
void | setPlaneIndex(int)

Notifier signal:

void | planeIndexChanged(int planeIndex)

## Member Function Documentation

### QClipPlane::QClipPlane(Qt3DCore::QNode *parent = nullptr)

Default constructs an instance of QClipPlane.