SceneElement QML Type | Runtime 2.1

Qt 3D Studio | Runtime | QML Types | SceneElement QML Type

Qt 3D Studio Runtime 2.1 Manual

# SceneElement QML Type

Controls the special Scene or Component scene objects in a Qt 3D Studio presentation. More...

Import Statement: | import .
Instantiates: | Q3DSSceneElement
Inherits: | Element

- List of all members, including inherited members

## Properties

- currentSlideIndex : int
- currentSlideName : string
- previousSlideIndex : int
- previousSlideName : string

## Signals

- currentSlideIndexChanged(int currentSlideIndex)
- currentSlideNameChanged(string currentSlideName)
- previousSlideIndexChanged(int previousSlideIndex)
- previousSlideNameChanged(string previousSlideName)

## Methods

- void goToSlide(bool next, bool wrap)
- void goToTime(string elementPath, real time)

## Detailed Description

This type is a convenience for controlling the properties of Scene and Component objects in the scene. These are special since they have a time context, meaning they control a timline and a set of associated slides.

See also Studio3D, Presentation, and Element.

## Property Documentation

currentSlideIndex : int

Holds the index of the currently active slide of the tracked time context.

Changing the current slide via this property is asynchronous. The property value will not actually change until the next frame has been processed, and even then only if the new slide was valid.

Note: If this property is set to something else than the default slide for the scene at the initial declaration of SceneElement, a changed signal for the default slide may still be emitted before the slide changes to the desired one. This happens in order to ensure we end up with the index of the slide that is actually shown even if the slide specified in the initial declaration is invalid.

currentSlideName : string

Holds the name of the currently active slide of the tracked time context.

Changing the current slide via this property is asynchronous. The property value will not actually change until the next frame has been processed, and even then only if the new slide was valid.

Note: If this property is set to something else than the default slide for the scene at the initial declaration of SceneElement, a changed signal for the default slide may still be emitted before the slide changes to the desired one. This happens in order to ensure we end up with the index of the slide that is actually shown even if the slide specified in the initial declaration is invalid.

previousSlideIndex : int

Holds the index of the previously active slide of the tracked time context.

This property is read-only.

previousSlideName : string

Holds the name of the previously active slide of the tracked time context.

This property is read-only.

## Signal Documentation

currentSlideIndexChanged(int currentSlideIndex)

This signal is emitted when the current slide changes. The new value is provided in the currentSlideIndex parameter.

This signal is always emitted with currentSlideNameChanged.

The corresponding handler is `onCurrentSlideIndexChanged`.

currentSlideNameChanged(string currentSlideName)

This signal is emitted when the current slide changes. The new value is provided in the currentSlideName parameter.

This signal is always emitted with currentSlideIndexChanged.

The corresponding handler is `onCurrentSlideNameChanged`.

previousSlideIndexChanged(int previousSlideIndex)

This signal is emitted when the previous slide changes. The new value is provided in the previousSlideIndex parameter.

This signal is always emitted with previousSlideNameChanged.

The corresponding handler is `onPreviousSlideIndexChanged`.

previousSlideNameChanged(string previousSlideName)

This signal is emitted when the previous slide changes. The new value is provided in the previousSlideName parameter.

This signal is always emitted with previousSlideIndexChanged.

The corresponding handler is `onPreviousSlideNameChanged`.

## Method Documentation

void goToSlide(bool next, bool wrap)

Requests a time context (a Scene or a Component object) to change to the next or previous slide, depending on the value of next. If the context is already at the last or first slide, wrap defines if wrapping over to the first or last slide, respectively, occurs.

void goToTime(string elementPath, real time)

Sets a time context (a Scene or a Component element) to a specific playback time in seconds.

For behavior details, see Presentation::goToTime() documentation.