#include "steam/asset/sequence.hpp"

Description

TODO type comment.

Definition at line 83 of file sequence.hpp.

Static Public Member Functions
static PSequence	create (Asset::Ident const &idi)
	create and register a new Sequence instance

Static Public Member Functions inherited from AutoRegistered< Sequence >
static PTarget	create ()
	factory for creating smart-ptr managed TAR instances, automatically registered with the element-tracking registry.

static void	setRegistryInstance (Registry &registry_to_use)

static void	deactivateRegistryLink ()

static bool	is_attached_to (Registry const &someRegistry)

Protected Member Functions
virtual void	unlink ()
	release all links to other Asset objects held internally.

Protected Member Functions inherited from Struct
	Struct (const Asset::Ident &idi)

Protected Member Functions inherited from Asset
	Asset (const Ident &idi)
	Asset is a Interface class; usually, objects of concrete subclasses are created via specialised Factories.

virtual	~Asset ()=0

virtual void	unlink (IDA target)
	variant of unlink() dropping only the links to the given specific Asset, leaving all other links intact.

void	defineDependency (PAsset parent)
	establish a connection between this and the given parent asset, denoting we are in some way dependent on the parent.

void	defineDependency (Asset &parent)

Private Types
using	RFork = mobject::session::RFork

Private Member Functions
	Sequence (Ident const &)
	create an empty default configured Sequence

Additional Inherited Members
Public Types inherited from AutoRegistered< Sequence >
typedef lib::ElementTracker< Sequence >	Registry

typedef lib::OptionalRef< Registry >	RegistryLink

typedef P< Sequence >	PTarget

Static Public Attributes inherited from Struct
static StructFactory	retrieve
	storage for the static StructFactory instance

Public Attributes inherited from Asset
const Ident	ident
	Asset identification tuple.

Public Member Functions inherited from Struct
virtual const ID< Struct > &	getID () const
	<

Public Member Functions inherited from Asset
bool	operator== (Asset const &oa) const

auto	operator<=> (Asset const &oa) const

virtual	operator string () const

const vector< PAsset > &	getParents () const
	List of entities this asset depends on or requires to be functional.

const vector< PAsset > &	getDependant () const
	All the other assets requiring this asset to be functional.

bool	isActive () const
	weather this asset is switched on and consequently included in the fixture and participates in rendering

bool	enable (bool on=true)
	change the enabled status of this asset.

Public Member Functions inherited from AutoRegistered< Sequence >
void	detach ()
	detach this element from the element-tracking registry.

Protected Attributes inherited from Asset
const ID< Asset >	id
	Asset primary key.

set< string >	groups
	additional classification, selections or departments this asset belongs to.

const string	shortDesc
	user visible Name-ID.

const string	longDesc
	user visible qualification of the thing, unit or concept represented by this asset.

vector< PAsset >	parents

vector< PAsset >	dependants

bool	enabled

Static Protected Attributes inherited from AutoRegistered< Sequence >
static RegistryLink	getRegistry
	storage for the functor to link an AutoRegistered entity to the corresponding registration service

Constructor & Destructor Documentation

◆ Sequence()

Sequence ( Ident const & idi )

private

create an empty default configured Sequence

Definition at line 33 of file sequence.cpp.

Member Typedef Documentation

◆ RFork

using RFork = mobject::session::RFork

private

Definition at line 87 of file sequence.hpp.

Member Function Documentation

◆ create()

PSequence create ( Asset::Ident const & idi )

static

create and register a new Sequence instance

Definition at line 39 of file sequence.cpp.

References AutoRegistered< Sequence >::getRegistry, and AssetManager::instance.

◆ unlink()

void unlink ( )

protectedvirtual

release all links to other Asset objects held internally.

release all links to other dependent asset objects held internally and advise all parent assets to do so with the link to this asset.

The lifecycle of Asset objects is managed by smart pointers and the Asset manager. Calling unlink() breaks interconnections to other Assets in the central Object network comprising the session. Especially, the downward links to dependent entities are released, while the primary (upward) smart-ptr links to our prerequisites are still retained. The rationale is, after releasing these redundant or cyclic interlinking, when the AssetManager removes its DB entry for this asset, the smart pointer goes out of scope and causes unwinding of the whole dependency chain.

Note: we don't release upward links to parent assets, thus effectively keeping the parents alive, because frequently the accessibility of parent assets is part of our own contract. (e.g. media for clip assets)

Reimplemented from Asset.

Definition at line 53 of file sequence.cpp.

References AutoRegistered< TAR >::detach(), and Asset::unlink().

Here is the call graph for this function:

Inheritance diagram for Sequence:

Collaboration diagram for Sequence:

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

Description

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions