#include <infinitegrid_p.h>

Inheritance diagram for QQuick3DInfiniteGrid:

Collaboration diagram for QQuick3DInfiniteGrid:

Signals
void	visibleChanged ()

void	gridIntervalChanged ()

void	gridAxesChanged ()

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
	QQuick3DInfiniteGrid ()
	\qmlproperty float InfiniteGrid::gridInterval

	~QQuick3DInfiniteGrid () override

bool	visible () const

void	setVisible (bool newVisible)

float	gridInterval () const

void	setGridInterval (float newGridInterval)

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

bool	gridAxes () const

void	setGridAxes (bool newGridAxes)

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 ()

Properties
bool	visible

float	gridInterval

bool	gridAxes

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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)

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.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 24 of file infinitegrid_p.h.

Constructor & Destructor Documentation

◆ QQuick3DInfiniteGrid()

QT_BEGIN_NAMESPACE QQuick3DInfiniteGrid::QQuick3DInfiniteGrid ( )

\qmlproperty float InfiniteGrid::gridInterval

\qmltype InfiniteGrid
\inqmlmodule QtQuick3D.Helpers
\since 6.5
\brief Shows an infinite grid.

This helper implements an infinite grid in the horizontal plane.
The grid fades out as the grid lines converge or at the far clip distance,
whichever comes first.

The grid needs to be a child of the \l{SceneEnvironment}.

\qml
View3D {
    environment: SceneEnvironment {
        backgroundMode: SceneEnvironment.SkyBox
        lightProbe: Texture {
            textureData: ProceduralSkyTextureData{}
        }
        InfiniteGrid {
            gridInterval: 100
        }
    }

... } \endqml

This property defines the distance between grid lines. The default value is 1.0.

\qmlproperty bool InfiniteGrid::visible

This property determines whether the grid is shown. The default value is true.

\qmlproperty bool InfiniteGrid::gridAxes

This property determines whether the X and Y axes are marked. If true, the X-axis will be red and the Y-axis green. The default value is true.

Definition at line 56 of file infinitegrid.cpp.

◆ ~QQuick3DInfiniteGrid()

QQuick3DInfiniteGrid::~QQuick3DInfiniteGrid ( )

override

Definition at line 60 of file infinitegrid.cpp.

Member Function Documentation

◆ classBegin()

void QQuick3DInfiniteGrid::classBegin ( )

overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 115 of file infinitegrid.cpp.

◆ componentComplete()

void QQuick3DInfiniteGrid::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 94 of file infinitegrid.cpp.

References QObject::parent(), Q_ASSERT, qFuzzyIsNull(), qWarning, QQuick3DSceneEnvironment::setGridEnabled(), and QQuick3DSceneEnvironment::setGridScale().

Here is the call graph for this function:

◆ gridAxes()

bool QQuick3DInfiniteGrid::gridAxes ( ) const

Definition at line 119 of file infinitegrid.cpp.

◆ gridAxesChanged

void QQuick3DInfiniteGrid::gridAxesChanged ( )

signal

Referenced by setGridAxes().

Here is the caller graph for this function:

◆ gridInterval()

float QQuick3DInfiniteGrid::gridInterval ( ) const

Definition at line 79 of file infinitegrid.cpp.

◆ gridIntervalChanged

void QQuick3DInfiniteGrid::gridIntervalChanged ( )

signal

Referenced by setGridInterval().

Here is the caller graph for this function:

◆ setGridAxes()

void QQuick3DInfiniteGrid::setGridAxes ( bool newGridAxes )

Definition at line 124 of file infinitegrid.cpp.

References emit, and gridAxesChanged().

Here is the call graph for this function:

◆ setGridInterval()

void QQuick3DInfiniteGrid::setGridInterval ( float newGridInterval )

Definition at line 84 of file infinitegrid.cpp.

References emit, gridIntervalChanged(), qFuzzyCompare(), qFuzzyIsNull(), and QQuick3DSceneEnvironment::setGridScale().

Here is the call graph for this function:

◆ setVisible()

void QQuick3DInfiniteGrid::setVisible ( bool newVisible )

Definition at line 69 of file infinitegrid.cpp.

References emit, QQuick3DSceneEnvironment::setGridEnabled(), and visibleChanged().

Here is the call graph for this function:

◆ visible()

bool QQuick3DInfiniteGrid::visible ( ) const

Definition at line 64 of file infinitegrid.cpp.

◆ visibleChanged

void QQuick3DInfiniteGrid::visibleChanged ( )

signal

Referenced by setVisible().

Here is the caller graph for this function:

Property Documentation

◆ gridAxes

bool QQuick3DInfiniteGrid::gridAxes

readwrite

Definition at line 32 of file infinitegrid_p.h.

◆ gridInterval

float QQuick3DInfiniteGrid::gridInterval

readwrite

Definition at line 31 of file infinitegrid_p.h.

◆ visible

bool QQuick3DInfiniteGrid::visible

readwrite

Definition at line 30 of file infinitegrid_p.h.

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

qtquick3d/src/helpers/infinitegrid_p.h (248664a27174893e9af0991248b45f6200641b0f)
qtquick3d/src/helpers/infinitegrid.cpp (5ec518337bbf3ad13c6865629a23427c41f8a885)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuick3DInfiniteGrid()

◆ ~QQuick3DInfiniteGrid()

Member Function Documentation

◆ classBegin()

◆ componentComplete()

◆ gridAxes()

◆ gridAxesChanged

◆ gridInterval()

◆ gridIntervalChanged

◆ setGridAxes()

◆ setGridInterval()

◆ setVisible()

◆ visible()

◆ visibleChanged

Property Documentation

◆ gridAxes

◆ gridInterval

◆ visible