Represents a command to initialize Showcase for a component scene and start a sequence for the component.
This class sends a command to the Metabox API to initialize showcase if the component has a sequence.
To check this, find the showcase property in the current component and listen to the 'configuratorDataUpdated' event.
If this property exists, you can send the init showcase command.
To listen for changes after sending this command, listen to the 'showcaseStatusChanged' event.
What does it unlock?
Initializes and displays the showcase/demo view for the configurator. Used when transitioning into presentation or demo mode.
Practical Application
Loads the showcase/animation sequence attached to the current component. Must be called BEFORE PlayShowcase.
Use to initialize auto-playing product demos, trade show presentations, or hero section animations on landing pages.
AI Coding Best Practices
ALWAYS call InitShowcase() before PlayShowcase(). Required sequence: InitShowcase → PlayShowcase → PauseShowcase/StopShowcase.
Subscribe to showcaseStatusChanged to track playback state ('playing'/'paused'/'stopped').
Example
import { Communicator, ShowCaseStatus, InitShowcase } from'@3dsource/metabox-modular-configurator-api'; window.env3DSource.apiReady = (api: Communicator) => { //Subscribe to the event before sending the command to ensure you capture the response api.addEventListener('showcaseStatusChanged', (data:ShowCaseStatus) => { console.log('Showcase status value after changed:', data); });
Represents a command to initialize Showcase for a component scene and start a sequence for the component. This class sends a command to the Metabox API to initialize showcase if the component has a sequence. To check this, find the showcase property in the current component and listen to the 'configuratorDataUpdated' event. If this property exists, you can send the init showcase command.
To listen for changes after sending this command, listen to the 'showcaseStatusChanged' event.
What does it unlock?
Initializes and displays the showcase/demo view for the configurator. Used when transitioning into presentation or demo mode.
Practical Application
Loads the showcase/animation sequence attached to the current component. Must be called BEFORE PlayShowcase. Use to initialize auto-playing product demos, trade show presentations, or hero section animations on landing pages.
AI Coding Best Practices
ALWAYS call InitShowcase() before PlayShowcase(). Required sequence: InitShowcase → PlayShowcase → PauseShowcase/StopShowcase. Subscribe to showcaseStatusChanged to track playback state ('playing'/'paused'/'stopped').
Example