Clip Class Reference

#include "steam/asset/clip.hpp"

Description

bookkeeping (Asset) view of a media clip.

Definition at line 35 of file asset/clip.hpp.

Public Member Functions
virtual PClip	createClip () const
	Specialisation of the asset::Media interface method, just returning the already existing Clip-MO.
Public Member Functions inherited from Media
const string &	getFilename () const
virtual const ID< Media > &	getID () const
	<
PProcPatt	howtoProc () const
	Service Access Point for getting a processing template describing how to build the render nodes network necessary for this Media or Clip.
PClip	createClip ()
	Service Access Point for creating a Clip entity usable within the Session from a given Media or Clip Asset.
virtual Duration	getLength () 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.

Friends
class	MediaFactory

Protected Member Functions
	Clip (Media &mediaref)
virtual PClipAsset	getClipAsset ()
	return this wrapped into a shared ptr, because it's already the desired asset::Clip
virtual PMedia	checkCompound () const
	specialisation delegating the decision to the media asset referred by this clip
Protected Member Functions inherited from Media
	Media (const Asset::Ident &idi, const string &file, Duration length)
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 ()
	release all links to other Asset objects held internally.
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 Attributes
const Media &	source_
	media source of this clip
PClip	clipMO_
	the corresponding (dependent) clip-MO

Additional Inherited Members
Public Types inherited from Media
using	PMedia = lib::P< Media >
using	PClipAsset = lib::P< steam::asset::Clip >
using	PProcPatt = lib::P< steam::asset::ProcPatt >
using	PClip = mobject::Placement< mobject::session::Clip >
Static Public Attributes inherited from Media
static MediaFactory	create
	storage for the static MediaFactory instance
Public Attributes inherited from Asset
const Ident	ident
	Asset identification tuple.
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

Constructor & Destructor Documentation

Clip()

Clip ( Media &  mediaref )

protected

Definition at line 57 of file asset/clip.cpp.

References Asset::defineDependency().

Here is the call graph for this function:

Member Function Documentation

createClip()

Media::PClip createClip ( ) const

virtual

Specialisation of the asset::Media interface method, just returning the already existing Clip-MO.

Every asset::Clip internally holds a Clip-MO, which has been created alongside. This Clip-MO may have several Placements or no placement at all (meaning it need not be placed within the session)

Definition at line 76 of file asset/clip.cpp.

References Clip::clipMO_.

getClipAsset()

Media::PClipAsset getClipAsset ( )

protectedvirtual

return this wrapped into a shared ptr, because it's already the desired asset::Clip

Reimplemented from Media.

Definition at line 87 of file asset/clip.cpp.

References AssetManager::wrap().

Here is the call graph for this function:

checkCompound()

Media::PMedia checkCompound ( ) const

protectedvirtual

specialisation delegating the decision to the media asset referred by this clip

Reimplemented from Media.

Definition at line 98 of file asset/clip.cpp.

References Media::checkCompound(), and Clip::source_.

Here is the call graph for this function:

Member Data Documentation

source_

const Media& source_

private

media source of this clip

Definition at line 38 of file asset/clip.hpp.

Referenced by Clip::checkCompound().

clipMO_

PClip clipMO_

private

the corresponding (dependent) clip-MO

Definition at line 41 of file asset/clip.hpp.

Referenced by Clip::createClip().

Friends And Related Symbol Documentation

MediaFactory

friend class MediaFactory

friend

Definition at line 48 of file asset/clip.hpp.

Inheritance diagram for Clip:

Collaboration diagram for Clip:

---

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

• asset/clip.hpp
• asset/clip.cpp