#include "steam/mobject/session/relativelocation.hpp"

Description

Todo:: just a design sketch, nothing finished yet. possibly to be reworked or phased out completely. See Trac #100

Definition at line 42 of file relativelocation.hpp.

Public Types
enum	RelType { SAMETIME , ATTACH }
	the possible kinds of RelativePlacements More...

Public Member Functions
virtual RelativeLocation *	clone () const

Public Member Functions inherited from LocatingPin
const SolutionData	resolve () const
	implementing the core Placement functionality.

bool	isOverdetermined () const

FixedLocation &	operator() (Time start, Fork track=0)

RelativeLocation &	operator() (PlacementRef< MObject > &refObj, Offset const &offset=Offset(Time::ZERO))

	LocatingPin (const LocatingPin &)
	it's OK to copy a LocainngPin, causing duplication of any chained lPins

LocatingPin &	operator= (const LocatingPin &)

virtual	~LocatingPin ()

	LocatingPin ()

Friends
class	LocatingPin

Protected Member Functions
	RelativeLocation (PlaRef const &a, Offset const &ofs)

virtual void	intersect (LocatingSolution &) const

Protected Member Functions inherited from LocatingPin
virtual int	getPrioLevel () const
	order to consider when resolving.

LocatingPin &	addChain (LocatingPin *)

void	resolve (LocatingSolution &) const

Protected Attributes
RelType	relType
	the kind of relation denoted by this Placement

Offset	offset_
	Offset the actual position by this (time) value relative to the anchor point.

Protected Attributes inherited from LocatingPin
std::unique_ptr< LocatingPin >	next_
	next additional Pin, if any

Private Attributes
const PlaRef	anchor_

Additional Inherited Members
Protected Types inherited from LocatingPin
typedef lib::time::Time	Time

typedef lib::time::TimeVar	TimeVar

typedef lib::time::Offset	Offset

typedef Time *	Fork

typedef std::shared_ptr< asset::Pipe >	Pipe

typedef std::pair< Time, Pipe >	SolutionData

Constructor & Destructor Documentation

◆ RelativeLocation()

RelativeLocation	(	PlaRef const &	a,
		Offset const &	ofs
	)

inlineprotected

Definition at line 59 of file relativelocation.hpp.

Member Enumeration Documentation

◆ RelType

enum RelType

the possible kinds of RelativePlacements

Enumerator

SAMETIME

place subject at the same time as the anchor

ATTACH

attach subject to anchor (e.g.

an effect to a clip)

Definition at line 53 of file relativelocation.hpp.

Member Function Documentation

◆ intersect()

void intersect ( LocatingSolution & solution ) const

protectedvirtual

Reimplemented from LocatingPin.

Definition at line 37 of file relativelocation.cpp.

References LocatingPin::intersect().

Here is the call graph for this function:

◆ clone()

RelativeLocation * clone ( ) const

virtual

Reimplemented from LocatingPin.

Definition at line 30 of file relativelocation.cpp.

Member Data Documentation

◆ anchor_

const PlaRef anchor_

private

Definition at line 46 of file relativelocation.hpp.

◆ relType

RelType relType

protected

the kind of relation denoted by this Placement

Definition at line 63 of file relativelocation.hpp.

◆ offset_

Offset offset_

protected

Offset the actual position by this (time) value relative to the anchor point.

Definition at line 66 of file relativelocation.hpp.

Friends And Related Symbol Documentation

◆ LocatingPin

friend class LocatingPin

friend

Definition at line 60 of file relativelocation.hpp.

Inheritance diagram for RelativeLocation:

Collaboration diagram for RelativeLocation:

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

Description

Public Types

Public Member Functions

Friends

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members