Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Properties | List of all members
QQuick3DReflectionProbe Class Reference

#include <qquick3dreflectionprobe_p.h>

+ Inheritance diagram for QQuick3DReflectionProbe:
+ Collaboration diagram for QQuick3DReflectionProbe:

Public Types

enum class  ReflectionQuality {
  VeryLow , Low , Medium , High ,
  VeryHigh
}
 
enum class  ReflectionRefreshMode { FirstFrame , EveryFrame }
 
enum class  ReflectionTimeSlicing { None , AllFacesAtOnce , IndividualFaces }
 
- Public Types inherited from QQuick3DNode
enum  TransformSpace { LocalSpace , ParentSpace , SceneSpace }
 
enum  StaticFlags { None }
 

Public Slots

void setQuality (ReflectionQuality reflectionQuality)
 
void setClearColor (const QColor &clearColor)
 
void setRefreshMode (ReflectionRefreshMode newRefreshMode)
 
void setTimeSlicing (ReflectionTimeSlicing newTimeSlicing)
 
void setParallaxCorrection (bool parallaxCorrection)
 
void setBoxSize (const QVector3D &newBoxSize)
 
 Q_REVISION (6, 4) void setDebugView(bool debugView)
 
 Q_REVISION (6, 4) void setBoxOffset(const QVector3D &boxOffset)
 
 Q_REVISION (6, 5) void setTexture(QQuick3DCubeMapTexture *newTexture)
 
- Public Slots inherited from QQuick3DNode
void setX (float x)
 
void setY (float y)
 
void setZ (float z)
 
void setRotation (const QQuaternion &rotation)
 
void setEulerRotation (const QVector3D &eulerRotation)
 
void setPosition (const QVector3D &position)
 
void setScale (const QVector3D &scale)
 
void setPivot (const QVector3D &pivot)
 
void setLocalOpacity (float opacity)
 
void setVisible (bool visible)
 
void setStaticFlags (int staticFlags)
 
- Public Slots inherited from QQuick3DObject
void update ()
 
void setParentItem (QQuick3DObject *parentItem)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void qualityChanged ()
 
void clearColorChanged ()
 
void refreshModeChanged ()
 
void timeSlicingChanged ()
 
void parallaxCorrectionChanged ()
 
void boxSizeChanged ()
 
 Q_REVISION (6, 4) void debugViewChanged()
 
 Q_REVISION (6, 4) void boxOffsetChanged()
 
 Q_REVISION (6, 5) void textureChanged()
 
- Signals inherited from QQuick3DNode
void xChanged ()
 
void yChanged ()
 
void zChanged ()
 
void rotationChanged ()
 
void eulerRotationChanged ()
 
void positionChanged ()
 
void scaleChanged ()
 
void pivotChanged ()
 
void localOpacityChanged ()
 
void visibleChanged ()
 
void forwardChanged ()
 
void upChanged ()
 
void rightChanged ()
 
void sceneTransformChanged ()
 
void scenePositionChanged ()
 
void sceneRotationChanged ()
 
void sceneScaleChanged ()
 
void staticFlagsChanged ()
 
- Signals inherited from QQuick3DObject
void parentChanged ()
 
void childrenChanged ()
 
void stateChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuick3DReflectionProbe (QQuick3DNode *parent=nullptr)
 \qmltype ReflectionProbe \inherits Node \inqmlmodule QtQuick3D
 
 ~QQuick3DReflectionProbe () override
 
ReflectionQuality quality () const
 \qmlproperty enumeration ReflectionProbe::quality
 
QColor clearColor () const
 \qmlproperty Color ReflectionProbe::clearColor
 
ReflectionRefreshMode refreshMode () const
 \qmlproperty enumeration ReflectionProbe::refreshMode
 
ReflectionTimeSlicing timeSlicing () const
 \qmlproperty enumeration ReflectionProbe::timeSlicing
 
bool parallaxCorrection () const
 \qmlproperty bool ReflectionProbe::parallaxCorrection
 
QVector3D boxSize () const
 \qmlproperty vector3d ReflectionProbe::boxSize
 
 Q_REVISION (6, 4) bool debugView() const
 
 Q_REVISION (6, 4) QVector3D boxOffset() const
 
 Q_REVISION (6, 4) Q_INVOKABLE void scheduleUpdate()
 
 Q_REVISION (6, 5) QQuick3DCubeMapTexture *texture() const
 
- Public Member Functions inherited from QQuick3DNode
 QQuick3DNode (QQuick3DNode *parent=nullptr)
 \qmltype Node \inherits Object3D \inqmlmodule QtQuick3D
 
 ~QQuick3DNode () override
 
float x () const
 \qmlproperty real QtQuick3D::Node::x
 
float y () const
 \qmlproperty real QtQuick3D::Node::y
 
float z () const
 \qmlproperty real QtQuick3D::Node::z
 
QQuaternion rotation () const
 \qmlproperty quaternion QtQuick3D::Node::rotation
 
QVector3D eulerRotation () const
 \qmlproperty vector3d QtQuick3D::Node::eulerRotation
 
QVector3D position () const
 \qmlproperty vector3d QtQuick3D::Node::position
 
QVector3D scale () const
 \qmlproperty vector3d QtQuick3D::Node::scale
 
QVector3D pivot () const
 \qmlproperty vector3d QtQuick3D::Node::pivot
 
float localOpacity () const
 \qmlproperty real QtQuick3D::Node::opacity
 
bool visible () const
 \qmlproperty bool QtQuick3D::Node::visible
 
int staticFlags () const
 \qmlproperty int QtQuick3D::Node::staticFlags
 
QQuick3DNode * parentNode () const
 
QVector3D forward () const
 \qmlproperty vector3d QtQuick3D::Node::forward \readonly
 
QVector3D up () const
 \qmlproperty vector3d QtQuick3D::Node::up \readonly
 
QVector3D right () const
 \qmlproperty vector3d QtQuick3D::Node::right \readonly
 
QVector3D scenePosition () const
 \qmlproperty vector3d QtQuick3D::Node::scenePosition \readonly
 
QQuaternion sceneRotation () const
 \qmlproperty quaternion QtQuick3D::Node::sceneRotation \readonly
 
QVector3D sceneScale () const
 \qmlproperty vector3d QtQuick3D::Node::sceneScale \readonly
 
QMatrix4x4 sceneTransform () const
 \qmlproperty matrix4x4 QtQuick3D::Node::sceneTransform \readonly
 
Q_INVOKABLE void rotate (qreal degrees, const QVector3D &axis, QQuick3DNode::TransformSpace space)
 \qmlmethod QtQuick3D::Node::rotate(real degrees, vector3d axis, enumeration space)
 
Q_INVOKABLE QVector3D mapPositionToScene (const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToScene(vector3d localPosition)
 
Q_INVOKABLE QVector3D mapPositionFromScene (const QVector3D &scenePosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromScene(vector3d scenePosition)
 
Q_INVOKABLE QVector3D mapPositionToNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionToNode(QtQuick3D::Node node, vector3d localPosition)
 
Q_INVOKABLE QVector3D mapPositionFromNode (const QQuick3DNode *node, const QVector3D &localPosition) const
 \qmlmethod vector3d QtQuick3D::Node::mapPositionFromNode(QtQuick3D::Node node, vector3d localPosition)
 
Q_INVOKABLE QVector3D mapDirectionToScene (const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToScene(vector3d localDirection)
 
Q_INVOKABLE QVector3D mapDirectionFromScene (const QVector3D &sceneDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromScene(vector3d sceneDirection)
 
Q_INVOKABLE QVector3D mapDirectionToNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionToNode(QtQuick3D::Node node, vector3d localDirection)
 
Q_INVOKABLE QVector3D mapDirectionFromNode (const QQuick3DNode *node, const QVector3D &localDirection) const
 \qmlmethod vector3d QtQuick3D::Node::mapDirectionFromNode(QtQuick3D::Node node, vector3d localDirection)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Types

enum class  DirtyFlag {
  QualityDirty = (1 << 0) , ClearColorDirty = (1 << 1) , RefreshModeDirty = (1 << 2) , ParallaxCorrectionDirty = (1 << 3) ,
  BoxDirty = (1 << 4) , TimeSlicingDirty = (1 << 5) , TextureDirty = (1 << 6)
}
 

Protected Member Functions

QSSGRenderGraphObject * updateSpatialNode (QSSGRenderGraphObject *node) override
 
void markAllDirty () override
 
void itemChange (ItemChange, const ItemChangeData &) override
 
- Protected Member Functions inherited from QQuick3DNode
void connectNotify (const QMetaMethod &signal) override
 
void disconnectNotify (const QMetaMethod &signal) override
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
 QQuick3DNode (QQuick3DNodePrivate &dd, QQuick3DNode *parent=nullptr)
 
- Protected Member Functions inherited from QQuick3DObject
 QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
bool isComponentComplete () const
 
virtual void preSync ()
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Protected Attributes

DirtyFlags m_dirtyFlags
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 

Properties

ReflectionQuality quality
 
QColor clearColor
 
ReflectionRefreshMode refreshMode
 
ReflectionTimeSlicing timeSlicing
 
bool parallaxCorrection
 
QVector3D boxSize
 
QVector3D boxOffset
 \qmlproperty vector3d ReflectionProbe::boxOffset
 
bool debugView
 \qmlproperty bool ReflectionProbe::debugView
 
QQuick3DCubeMapTexture * texture
 \qmlproperty CubeMapTexture ReflectionProbe::texture
 
- Properties inherited from QQuick3DNode
float x
 
float y
 
float z
 
QQuaternion rotation
 
QVector3D eulerRotation
 
QVector3D position
 
QVector3D scale
 
QVector3D pivot
 
float opacity
 
bool visible
 
QVector3D forward
 
QVector3D up
 
QVector3D right
 
QVector3D scenePosition
 
QQuaternion sceneRotation
 
QVector3D sceneScale
 
QMatrix4x4 sceneTransform
 
int staticFlags
 
- Properties inherited from QQuick3DObject
QQuick3DObject * parent
 \qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 28 of file qquick3dreflectionprobe_p.h.

Member Enumeration Documentation

◆ DirtyFlag

enum class QQuick3DReflectionProbe::DirtyFlag
strongprotected
Enumerator
QualityDirty 
ClearColorDirty 
RefreshModeDirty 
ParallaxCorrectionDirty 
BoxDirty 
TimeSlicingDirty 
TextureDirty 

Definition at line 109 of file qquick3dreflectionprobe_p.h.

◆ ReflectionQuality

enum class QQuick3DReflectionProbe::ReflectionQuality
strong
Enumerator
VeryLow 
Low 
Medium 
High 
VeryHigh 

Definition at line 44 of file qquick3dreflectionprobe_p.h.

◆ ReflectionRefreshMode

enum class QQuick3DReflectionProbe::ReflectionRefreshMode
strong
Enumerator
FirstFrame 
EveryFrame 

Definition at line 53 of file qquick3dreflectionprobe_p.h.

◆ ReflectionTimeSlicing

enum class QQuick3DReflectionProbe::ReflectionTimeSlicing
strong
Enumerator
None 
AllFacesAtOnce 
IndividualFaces 

Definition at line 59 of file qquick3dreflectionprobe_p.h.

Constructor & Destructor Documentation

◆ QQuick3DReflectionProbe()

QT_BEGIN_NAMESPACE QQuick3DReflectionProbe::QQuick3DReflectionProbe ( QQuick3DNode * parent = nullptr)
explicit

\qmltype ReflectionProbe \inherits Node \inqmlmodule QtQuick3D

Defines a reflection probe in the scene.

A reflection probe is used to provide reflections of the current scene to the objects. The probe provides properties to the runtime which are then used to render the scene to a cube map. The cube map is then used as the reflection information for the reflecting objects.

See also
{Qt Quick 3D - Reflection Probes Example}

Definition at line 25 of file qquick3dreflectionprobe.cpp.

References QObject::connect(), and QQuick3DNode::scenePositionChanged().

+ Here is the call graph for this function:

◆ ~QQuick3DReflectionProbe()

QQuick3DReflectionProbe::~QQuick3DReflectionProbe ( )
inlineoverride

Definition at line 67 of file qquick3dreflectionprobe_p.h.

Member Function Documentation

◆ boxSize()

QVector3D QQuick3DReflectionProbe::boxSize ( ) const

\qmlproperty vector3d ReflectionProbe::boxSize

Box size is used to determine which objects get their reflections from this ReflectionProbe. Objects that are inside the box are under the influence of this ReflectionProbe. If an object lies inside more than one reflection probe at the same time, the object is considered to be inside the nearest reflection probe. With \l ReflectionProbe::parallaxCorrection turned on the size is also used to calculate the distance of the reflections in the cube map.

See also
parallaxCorrection

Definition at line 146 of file qquick3dreflectionprobe.cpp.

◆ boxSizeChanged

void QQuick3DReflectionProbe::boxSizeChanged ( )
signal

Referenced by setBoxSize().

+ Here is the caller graph for this function:

◆ clearColor()

QColor QQuick3DReflectionProbe::clearColor ( ) const

\qmlproperty Color ReflectionProbe::clearColor

Clear color is the color used to clear the cube map prior rendering the scene.

Definition at line 67 of file qquick3dreflectionprobe.cpp.

◆ clearColorChanged

void QQuick3DReflectionProbe::clearColorChanged ( )
signal

Referenced by setClearColor().

+ Here is the caller graph for this function:

◆ itemChange()

void QQuick3DReflectionProbe::itemChange ( ItemChange ,
const ItemChangeData &  )
overrideprotectedvirtual

Reimplemented from QQuick3DNode.

Definition at line 31 of file qquick3dreflectionprobe.cpp.

◆ markAllDirty()

void QQuick3DReflectionProbe::markAllDirty ( )
overrideprotectedvirtual

Reimplemented from QQuick3DNode.

Definition at line 373 of file qquick3dreflectionprobe.cpp.

References BoxDirty, ClearColorDirty, m_dirtyFlags, QQuick3DNode::markAllDirty(), ParallaxCorrectionDirty, QualityDirty, RefreshModeDirty, and TimeSlicingDirty.

Referenced by updateSpatialNode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parallaxCorrection()

bool QQuick3DReflectionProbe::parallaxCorrection ( ) const

\qmlproperty bool ReflectionProbe::parallaxCorrection

By default the reflections provided by the reflection probe are assumed to be from an infinite distance similar to the skybox. This works fine for environmental reflections but for tight spaces this causes perspective errors in the reflections. To fix this parallax correction can be turned on. The distance of the reflection is then determined by the \l ReflectionProbe::boxSize property.

See also
boxSize

Definition at line 130 of file qquick3dreflectionprobe.cpp.

◆ parallaxCorrectionChanged

void QQuick3DReflectionProbe::parallaxCorrectionChanged ( )
signal

Referenced by setParallaxCorrection().

+ Here is the caller graph for this function:

◆ Q_REVISION() [1/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  ) const

◆ Q_REVISION() [2/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  )

◆ Q_REVISION() [3/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  ) const

◆ Q_REVISION [4/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  )
signal

◆ Q_REVISION [5/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  )
signal

◆ Q_REVISION [6/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  ) const &
slot

◆ Q_REVISION [7/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
4  )
slot

◆ Q_REVISION() [8/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
5  ) const

◆ Q_REVISION [9/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
5  )
slot

◆ Q_REVISION [10/10]

QQuick3DReflectionProbe::Q_REVISION ( 6 ,
5  )
signal

◆ quality()

QQuick3DReflectionProbe::ReflectionQuality QQuick3DReflectionProbe::quality ( ) const

\qmlproperty enumeration ReflectionProbe::quality

Quality determines the resolution of the cube map.

Possible values are: \value ReflectionProbe.VeryLow Renders a reflection map using a 128x128 texture. \value ReflectionProbe.Low Renders a reflection map using a 256x256 texture. \value ReflectionProbe.Medium Renders a reflection map using a 512x512 texture. \value ReflectionProbe.High Renders a reflection map using a 1024x1024 texture. \value ReflectionProbe.VeryHigh Renders a reflection map using a 2048x2048 texture.

The default value is ReflectionProbe.Low

Definition at line 57 of file qquick3dreflectionprobe.cpp.

◆ qualityChanged

void QQuick3DReflectionProbe::qualityChanged ( )
signal

Referenced by setQuality().

+ Here is the caller graph for this function:

◆ refreshMode()

QQuick3DReflectionProbe::ReflectionRefreshMode QQuick3DReflectionProbe::refreshMode ( ) const

\qmlproperty enumeration ReflectionProbe::refreshMode

Refresh mode tells the runtime how often the cube map should be updated.

Possible values are: \value ReflectionProbe.FirstFrame Renders the scene on the first frame. \value ReflectionProbe.EveryFrame Renders the scene every frame.

The default value is ReflectionProbe.EveryFrame

Note
Use ReflectionProbe.FirstFrame for improved performance.

Definition at line 86 of file qquick3dreflectionprobe.cpp.

◆ refreshModeChanged

void QQuick3DReflectionProbe::refreshModeChanged ( )
signal

Referenced by setRefreshMode().

+ Here is the caller graph for this function:

◆ setBoxSize

void QQuick3DReflectionProbe::setBoxSize ( const QVector3D & newBoxSize)
slot

Definition at line 257 of file qquick3dreflectionprobe.cpp.

References BoxDirty, boxSize, boxSizeChanged(), emit, m_dirtyFlags, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setClearColor

void QQuick3DReflectionProbe::setClearColor ( const QColor & clearColor)
slot

Definition at line 217 of file qquick3dreflectionprobe.cpp.

References clearColor, clearColorChanged(), ClearColorDirty, emit, m_dirtyFlags, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setParallaxCorrection

void QQuick3DReflectionProbe::setParallaxCorrection ( bool parallaxCorrection)
slot

Definition at line 247 of file qquick3dreflectionprobe.cpp.

References emit, m_dirtyFlags, parallaxCorrection, parallaxCorrectionChanged(), ParallaxCorrectionDirty, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setQuality

void QQuick3DReflectionProbe::setQuality ( QQuick3DReflectionProbe::ReflectionQuality reflectionQuality)
slot

Definition at line 206 of file qquick3dreflectionprobe.cpp.

References emit, m_dirtyFlags, qualityChanged(), QualityDirty, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setRefreshMode

void QQuick3DReflectionProbe::setRefreshMode ( ReflectionRefreshMode newRefreshMode)
slot

Definition at line 227 of file qquick3dreflectionprobe.cpp.

References emit, m_dirtyFlags, refreshModeChanged(), RefreshModeDirty, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setTimeSlicing

void QQuick3DReflectionProbe::setTimeSlicing ( ReflectionTimeSlicing newTimeSlicing)
slot

Definition at line 237 of file qquick3dreflectionprobe.cpp.

References emit, m_dirtyFlags, timeSlicingChanged(), TimeSlicingDirty, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ timeSlicing()

QQuick3DReflectionProbe::ReflectionTimeSlicing QQuick3DReflectionProbe::timeSlicing ( ) const

\qmlproperty enumeration ReflectionProbe::timeSlicing

Time slicing determines how the cube map render is timed.

Possible values are: \value ReflectionProbe.None All faces of the cube map are rendered and prefiltered during one frame.

\value ReflectionProbe.AllFacesAtOnce All faces are rendered during one frame but the prefiltering is divided to subsquent frames with each mip level handled on their own frame. Rough surface reflections are thus refreshed every sixth frame while smooth surfaces have reflections that refresh every frame.

\value ReflectionProbe.IndividualFaces Each face is rendered and prefiltered in a separate frame. Thus all reflections are refreshed every sixth frame.

The default value is ReflectionProbe.None

Note
Use ReflectionProbe.AllFacesAtOnce or ReflectionProbe.IndividualFaces to increase performance.

Definition at line 115 of file qquick3dreflectionprobe.cpp.

◆ timeSlicingChanged

void QQuick3DReflectionProbe::timeSlicingChanged ( )
signal

Referenced by setTimeSlicing().

+ Here is the caller graph for this function:

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DReflectionProbe::updateSpatialNode ( QSSGRenderGraphObject * node)
overrideprotectedvirtual

Reimplemented from QQuick3DNode.

Definition at line 302 of file qquick3dreflectionprobe.cpp.

References AllFacesAtOnce, QSSGRenderReflectionProbe::AllFacesAtOnce, BoxDirty, QSSGRenderReflectionProbe::boxOffset, QSSGRenderReflectionProbe::boxSize, QSSGRenderReflectionProbe::clearColor, ClearColorDirty, EveryFrame, QSSGRenderReflectionProbe::EveryFrame, FirstFrame, QSSGRenderReflectionProbe::FirstFrame, QQuick3DTexture::getRenderImage(), QSSGRenderReflectionProbe::hasScheduledUpdate, IndividualFaces, QSSGRenderReflectionProbe::IndividualFaces, m_dirtyFlags, markAllDirty(), None, QSSGRenderReflectionProbe::None, QSSGRenderReflectionProbe::parallaxCorrection, ParallaxCorrectionDirty, QualityDirty, QSSGRenderReflectionProbe::reflectionMapRes, QSSGRenderReflectionProbe::refreshMode, RefreshModeDirty, QSSGRenderReflectionProbe::texture, TextureDirty, QSSGRenderReflectionProbe::timeSlicing, TimeSlicingDirty, and QQuick3DNode::updateSpatialNode().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_dirtyFlags

DirtyFlags QQuick3DReflectionProbe::m_dirtyFlags
protected
Initial value:
= DirtyFlags(DirtyFlag::QualityDirty)
| DirtyFlags(DirtyFlag::ClearColorDirty)
| DirtyFlags(DirtyFlag::RefreshModeDirty)
| DirtyFlags(DirtyFlag::ParallaxCorrectionDirty)
| DirtyFlags(DirtyFlag::BoxDirty)
| DirtyFlags(DirtyFlag::TimeSlicingDirty)
| DirtyFlags(DirtyFlag::TextureDirty)

Definition at line 120 of file qquick3dreflectionprobe_p.h.

Referenced by markAllDirty(), setBoxSize(), setClearColor(), setParallaxCorrection(), setQuality(), setRefreshMode(), setTimeSlicing(), and updateSpatialNode().

Property Documentation

◆ boxOffset

QVector3D QQuick3DReflectionProbe::boxOffset
readwrite

\qmlproperty vector3d ReflectionProbe::boxOffset

Box offset is used to move the box relative to the reflection probe position. Since the probe captures the environment from its position, this property can be used to move the box around without affecting the position where the probe capture the environment. This property alongside with \l ReflectionProbe::boxSize will be used to determine the object that fall inside the box. With \l ReflectionProbe::parallaxCorrection turned on, this property can be used to position the box to get more accurate reflections.

See also
parallaxCorrection

Definition at line 37 of file qquick3dreflectionprobe_p.h.

◆ boxSize

QVector3D QQuick3DReflectionProbe::boxSize
readwrite

Definition at line 36 of file qquick3dreflectionprobe_p.h.

Referenced by setBoxSize().

◆ clearColor

QColor QQuick3DReflectionProbe::clearColor
readwrite

Definition at line 32 of file qquick3dreflectionprobe_p.h.

Referenced by setClearColor().

◆ debugView

bool QQuick3DReflectionProbe::debugView
readwrite

\qmlproperty bool ReflectionProbe::debugView

Since
6.4

If this property is set to true, a wireframe is rendered to visualize the reflection probe box.

Definition at line 38 of file qquick3dreflectionprobe_p.h.

◆ parallaxCorrection

bool QQuick3DReflectionProbe::parallaxCorrection
readwrite

Definition at line 35 of file qquick3dreflectionprobe_p.h.

Referenced by setParallaxCorrection().

◆ quality

ReflectionQuality QQuick3DReflectionProbe::quality
readwrite

Definition at line 31 of file qquick3dreflectionprobe_p.h.

◆ refreshMode

ReflectionRefreshMode QQuick3DReflectionProbe::refreshMode
readwrite

Definition at line 33 of file qquick3dreflectionprobe_p.h.

◆ texture

QQuick3DCubeMapTexture * QQuick3DReflectionProbe::texture
readwrite

\qmlproperty CubeMapTexture ReflectionProbe::texture

Since
6.5

Instead of rendering the scene, this cube map texture is used to show reflections in objects affected by this reflection probe.

See also
CubeMapTexture

Definition at line 39 of file qquick3dreflectionprobe_p.h.

◆ timeSlicing

ReflectionTimeSlicing QQuick3DReflectionProbe::timeSlicing
readwrite

Definition at line 34 of file qquick3dreflectionprobe_p.h.

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