monopoly::sequence::SequenceRuntime Class Reference

#include <SequenceRuntime.hpp>

Classes
struct	Node

Public Member Functions
	SequenceRuntime (RuntimeLimits limits={})
	~SequenceRuntime ()
	SequenceRuntime (const SequenceRuntime &)=delete
SequenceRuntime &	operator= (const SequenceRuntime &)=delete
std::expected< SequenceNodeId, RuntimeError >	start (std::shared_ptr< const SequenceProgram > program, std::uint16_t priority=0, ClockStartOptions options={}, std::optional< SequenceTransform > initialTransform=std::nullopt, std::uint8_t labelOverride=0)
std::expected< void, RuntimeError >	requestSoundFailure (SequenceNodeId id)
std::expected< void, RuntimeError >	requestSoundClock (SequenceNodeId id, std::int32_t mediaClock)
std::expected< void, RuntimeError >	requestVideoClock (SequenceNodeId node, std::int32_t mediaClock, std::int32_t duration, bool ended)
std::expected< void, RuntimeError >	update (std::int32_t parentClock)
std::expected< void, RuntimeError >	stop (SequenceNodeId node)
void	stopAll ()
std::expected< void, RuntimeError >	setPaused (SequenceNodeId node, bool paused)
std::expected< void, RuntimeError >	seek (SequenceNodeId node, std::int32_t time)
std::expected< void, RuntimeError >	setEndingAction (SequenceNodeId node, std::uint8_t action)
std::expected< void, RuntimeError >	setVolume (SequenceNodeId node, std::uint8_t volume)
std::expected< void, RuntimeError >	setPitch (SequenceNodeId node, std::uint16_t pitch)
std::expected< void, RuntimeError >	setPanning (SequenceNodeId node, std::int8_t panning)
std::expected< void, RuntimeError >	setScrollingWorldVisibility (SequenceNodeId node, bool onScreen)
std::vector< SequenceNodeId >	matching (data::DataId id, std::uint16_t priority, bool wholeTree=false) const
std::size_t	stopMatching (data::DataId id, std::uint16_t priority, bool wholeTree=false)
std::expected< std::size_t, RuntimeError >	setEndingActionMatching (data::DataId id, std::uint16_t priority, std::uint8_t action, bool wholeTree=false)
std::size_t	setVolumeMatching (data::DataId id, std::uint16_t priority, std::uint8_t volume, bool wholeTree=false)
std::size_t	setPitchMatching (data::DataId id, std::uint16_t priority, std::uint16_t pitch, bool wholeTree=false)
std::size_t	setPanningMatching (data::DataId id, std::uint16_t priority, std::int8_t panning, bool wholeTree=false)
std::size_t	moveMatching (data::DataId id, std::uint16_t priority, const SequenceTransform &transform, bool wholeTree=false)
std::size_t	forceRedrawMatching (data::DataId id, std::uint16_t priority, bool wholeTree=false)
std::optional< SequenceNodeView >	inspect (SequenceNodeId node) const
std::optional< SequenceInfoView >	info (data::DataId id, std::uint16_t priority, bool wholeTree=false) const
bool	isSequenceFinished (data::DataId id, std::uint16_t priority, bool wholeTree=false) const
std::optional< Matrix3D >	childMeshWorldMatrix (data::DataId id, std::uint16_t priority) const
std::vector< SequenceBitmapInstanceView >	bitmapInstances () const
std::vector< SequenceSoundInstanceView >	soundInstances () const
std::vector< SequenceVideoInstanceView >	videoInstances () const
std::vector< SequenceMeshInstanceView >	meshInstances () const
std::vector< SequenceScrollingWorldView >	scrollingWorldInstances () const
std::vector< SequenceCamera3DView >	cameraInstances () const
std::optional< SequenceCamera2DView >	camera2DForLabel (std::uint8_t label) const
std::optional< SequenceCamera3DView >	cameraForLabel (std::uint8_t label) const
std::vector< SequenceNodeId >	roots () const
std::size_t	liveNodeCount () const noexcept
std::span< const SequenceEvent >	events () const noexcept

Detailed Description

Definition at line 273 of file SequenceRuntime.hpp.

Constructor & Destructor Documentation

SequenceRuntime() [1/2]

monopoly::sequence::SequenceRuntime::SequenceRuntime ( RuntimeLimits  limits = {} )

explicit

Definition at line 784 of file SequenceRuntime.cpp.

~SequenceRuntime()

monopoly::sequence::SequenceRuntime::~SequenceRuntime ( )

default

SequenceRuntime() [2/2]

monopoly::sequence::SequenceRuntime::SequenceRuntime ( const SequenceRuntime &  )

delete

Member Function Documentation

bitmapInstances()

std::vector< SequenceBitmapInstanceView > monopoly::sequence::SequenceRuntime::bitmapInstances

(

)

const

Definition at line 1670 of file SequenceRuntime.cpp.

camera2DForLabel()

std::optional< SequenceCamera2DView > monopoly::sequence::SequenceRuntime::camera2DForLabel

(

std::uint8_t

label

)

const

Definition at line 1880 of file SequenceRuntime.cpp.

cameraForLabel()

std::optional< SequenceCamera3DView > monopoly::sequence::SequenceRuntime::cameraForLabel

(

std::uint8_t

label

)

const

Definition at line 1898 of file SequenceRuntime.cpp.

cameraInstances()

std::vector< SequenceCamera3DView > monopoly::sequence::SequenceRuntime::cameraInstances

(

)

const

Definition at line 1856 of file SequenceRuntime.cpp.

childMeshWorldMatrix()

std::optional< Matrix3D > monopoly::sequence::SequenceRuntime::childMeshWorldMatrix	(	data::DataId	id,
		std::uint16_t	priority
	)		const

Definition at line 1650 of file SequenceRuntime.cpp.

events()

std::span< const SequenceEvent > monopoly::sequence::SequenceRuntime::events ( ) const

noexcept

Definition at line 787 of file SequenceRuntime.cpp.

forceRedrawMatching()

std::size_t monopoly::sequence::SequenceRuntime::forceRedrawMatching	(	data::DataId	id,
		std::uint16_t	priority,
		bool	wholeTree = false
	)

Definition at line 1588 of file SequenceRuntime.cpp.

info()

std::optional< SequenceInfoView > monopoly::sequence::SequenceRuntime::info	(	data::DataId	id,
		std::uint16_t	priority,
		bool	wholeTree = false
	)		const

Definition at line 1622 of file SequenceRuntime.cpp.

inspect()

std::optional< SequenceNodeView > monopoly::sequence::SequenceRuntime::inspect

(

SequenceNodeId

node

)

const

Definition at line 1602 of file SequenceRuntime.cpp.

isSequenceFinished()

bool monopoly::sequence::SequenceRuntime::isSequenceFinished	(	data::DataId	id,
		std::uint16_t	priority,
		bool	wholeTree = false
	)		const

Definition at line 1638 of file SequenceRuntime.cpp.

liveNodeCount()

std::size_t monopoly::sequence::SequenceRuntime::liveNodeCount ( ) const

noexcept

Definition at line 786 of file SequenceRuntime.cpp.

matching()

std::vector< SequenceNodeId > monopoly::sequence::SequenceRuntime::matching	(	data::DataId	id,
		std::uint16_t	priority,
		bool	wholeTree = false
	)		const

Definition at line 1471 of file SequenceRuntime.cpp.

meshInstances()

std::vector< SequenceMeshInstanceView > monopoly::sequence::SequenceRuntime::meshInstances

(

)

const

Definition at line 1775 of file SequenceRuntime.cpp.

moveMatching()

std::size_t monopoly::sequence::SequenceRuntime::moveMatching	(	data::DataId	id,
		std::uint16_t	priority,
		const SequenceTransform &	transform,
		bool	wholeTree = false
	)

Definition at line 1577 of file SequenceRuntime.cpp.

operator=()

SequenceRuntime & monopoly::sequence::SequenceRuntime::operator= ( const SequenceRuntime &  )

delete

requestSoundClock()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::requestSoundClock	(	SequenceNodeId	id,
		std::int32_t	mediaClock
	)

Definition at line 1077 of file SequenceRuntime.cpp.

requestSoundFailure()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::requestSoundFailure

(

SequenceNodeId

id

)

Definition at line 1065 of file SequenceRuntime.cpp.

requestVideoClock()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::requestVideoClock	(	SequenceNodeId	node,
		std::int32_t	mediaClock,
		std::int32_t	duration,
		bool	ended
	)

Definition at line 1091 of file SequenceRuntime.cpp.

roots()

std::vector< SequenceNodeId > monopoly::sequence::SequenceRuntime::roots

(

)

const

Definition at line 1920 of file SequenceRuntime.cpp.

scrollingWorldInstances()

std::vector< SequenceScrollingWorldView > monopoly::sequence::SequenceRuntime::scrollingWorldInstances

(

)

const

Definition at line 1829 of file SequenceRuntime.cpp.

seek()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::seek	(	SequenceNodeId	node,
		std::int32_t	time
	)

Definition at line 1246 of file SequenceRuntime.cpp.

setEndingAction()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::setEndingAction	(	SequenceNodeId	node,
		std::uint8_t	action
	)

Definition at line 1115 of file SequenceRuntime.cpp.

setEndingActionMatching()

std::expected< std::size_t, RuntimeError > monopoly::sequence::SequenceRuntime::setEndingActionMatching	(	data::DataId	id,
		std::uint16_t	priority,
		std::uint8_t	action,
		bool	wholeTree = false
	)

Definition at line 1504 of file SequenceRuntime.cpp.

setPanning()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::setPanning	(	SequenceNodeId	node,
		std::int8_t	panning
	)

Definition at line 1160 of file SequenceRuntime.cpp.

setPanningMatching()

std::size_t monopoly::sequence::SequenceRuntime::setPanningMatching	(	data::DataId	id,
		std::uint16_t	priority,
		std::int8_t	panning,
		bool	wholeTree = false
	)

Definition at line 1557 of file SequenceRuntime.cpp.

setPaused()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::setPaused	(	SequenceNodeId	node,
		bool	paused
	)

Definition at line 1105 of file SequenceRuntime.cpp.

setPitch()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::setPitch	(	SequenceNodeId	node,
		std::uint16_t	pitch
	)

Definition at line 1144 of file SequenceRuntime.cpp.

setPitchMatching()

std::size_t monopoly::sequence::SequenceRuntime::setPitchMatching	(	data::DataId	id,
		std::uint16_t	priority,
		std::uint16_t	pitch,
		bool	wholeTree = false
	)

Definition at line 1539 of file SequenceRuntime.cpp.

setScrollingWorldVisibility()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::setScrollingWorldVisibility	(	SequenceNodeId	node,
		bool	onScreen
	)

Definition at line 1178 of file SequenceRuntime.cpp.

setVolume()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::setVolume	(	SequenceNodeId	node,
		std::uint8_t	volume
	)

Definition at line 1127 of file SequenceRuntime.cpp.

setVolumeMatching()

std::size_t monopoly::sequence::SequenceRuntime::setVolumeMatching	(	data::DataId	id,
		std::uint16_t	priority,
		std::uint8_t	volume,
		bool	wholeTree = false
	)

Definition at line 1520 of file SequenceRuntime.cpp.

soundInstances()

std::vector< SequenceSoundInstanceView > monopoly::sequence::SequenceRuntime::soundInstances

(

)

const

Definition at line 1697 of file SequenceRuntime.cpp.

start()

std::expected< SequenceNodeId, RuntimeError > monopoly::sequence::SequenceRuntime::start	(	std::shared_ptr< const SequenceProgram >	program,
		std::uint16_t	priority = 0,
		ClockStartOptions	options = {},
		std::optional< SequenceTransform >	initialTransform = std::nullopt,
		std::uint8_t	labelOverride = 0
	)

Definition at line 931 of file SequenceRuntime.cpp.

stop()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::stop

(

SequenceNodeId

node

)

Definition at line 1057 of file SequenceRuntime.cpp.

stopAll()

void monopoly::sequence::SequenceRuntime::stopAll

(

)

Definition at line 967 of file SequenceRuntime.cpp.

stopMatching()

std::size_t monopoly::sequence::SequenceRuntime::stopMatching	(	data::DataId	id,
		std::uint16_t	priority,
		bool	wholeTree = false
	)

Definition at line 1486 of file SequenceRuntime.cpp.

update()

std::expected< void, RuntimeError > monopoly::sequence::SequenceRuntime::update

(

std::int32_t

parentClock

)

Definition at line 1455 of file SequenceRuntime.cpp.

videoInstances()

std::vector< SequenceVideoInstanceView > monopoly::sequence::SequenceRuntime::videoInstances

(

)

const

Definition at line 1742 of file SequenceRuntime.cpp.

---

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

• SequenceRuntime.hpp
• SequenceRuntime.cpp