Class: TTimeGraphic

Declaration: VideoSequence.h

Taxonomy Categories:

Member Functions:

TTimeGraphic
~TTimeGraphic
GetTime
SetTime
GetMaximumBounds
Draw
GetGeometricBounds
GetLooseFitBounds
TransformBy
GetDuration
CreatePreferredTypeList
ChoosePreferredType
CreateSubrange
operator=
operator>>=
operator<<=
Hash

Interface Category:

API.

Inherits From:

MGraphic, TMediaSequence

Inherited By:

TGraphicSequence

Purpose:

Adds the concept of duration to an MGraphic to produce an interface for a graphic object that has time-varying characteristics.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

Derive to add functionality and concreteness.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TTimeGraphic::TTimeGraphic

TTimeGraphic ()
TTimeGraphic (const TTimeGraphic &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create an empty object.
Call this function directly.

Parameters:

Takes no parameters.
const TTimeGraphic & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::~TTimeGraphic

virtual ~ TTimeGraphic ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::GetTime

virtual void GetTime (TTime & time) const

Interface Category:

API.

Purpose:

Returns the current time within the object's duration.

Calling Context:

Call this function directly.

Parameters:

TTime & time -Where to put the return value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::SetTime

virtual void SetTime (const TTime & time)

Interface Category:

API.

Purpose:

Sets the current time within the object's duration.

Calling Context:

Call this function directly.

Parameters:

const TTime & time -The new current time.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::GetMaximumBounds

virtual TGRect GetMaximumBounds () const

Interface Category:

API.

Purpose:

Returns the maximum bounds the object has at any time in its duration.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

TGRect -The maximum bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::Draw

virtual void Draw (TGrafPort & port) const

Interface Category:

API.

Purpose:

Renders the graphic for the current time.

Calling Context:

Call this function directly.

Parameters:

TGrafPort & port -The GrafPort to draw into.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::GetGeometricBounds

virtual TGRect GetGeometricBounds () const

Interface Category:

API.

Purpose:

Returns the geometric bounds the object has at the current time.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

TGRect -The current geometric bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::GetLooseFitBounds

virtual TGRect GetLooseFitBounds (const TGrafPort *) const

Interface Category:

API.

Purpose:

Returns the current loose fit bounds.

Calling Context:

Call this function directly.

Parameters:

const TGrafPort * -The graf port to use.

Return Value:

TGRect -The current loose fit bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::TransformBy

virtual void TransformBy (const TGrafMatrix &)

Interface Category:

API.

Purpose:

Transforms this TTimeGraphic by applying the specified transformation matrix.

Calling Context:

Call this function directly.

Parameters:

const TGrafMatrix & -The transformation matrix.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::GetDuration

virtual void GetDuration (TTime & duration) const

Interface Category:

API.

Purpose:

Returns the duration of the object.

Calling Context:

Call this function directly.

Parameters:

TTime & duration -The duration returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::CreatePreferredTypeList

virtual void CreatePreferredTypeList (TSequenceOf<TMediaType> &) const

Interface Category:

API.

Purpose:

Creates a list of preferred TGraphicTypes for use in type negotiation.

Calling Context:

Call this function directly.

Parameters:

TSequenceOf<TMediaType> & theTypes -The list of types returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::ChoosePreferredType

virtual TMediaType * ChoosePreferredType (const TSequenceOf<TMediaType> &) const

Interface Category:

API.

Purpose:

Chooses a preferred TGraphicType from the given list of types.

Calling Context:

Call this function directly.

Parameters:

const TSequenceOf<TMediaType> & theChoices -The list of types to choose from.

Return Value:

TMediaType* -The preferred type from the given list or NIL if no selection can be made.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::CreateSubrange

virtual TMediaSequence * CreateSubrange (const TMediaRange & range) const

Interface Category:

API.

Purpose:

Create a new object that is a subsequence of the media sequence.

Calling Context:

Call this function directly.

Parameters:

const TMediaRange & range -The start and duration for the subsequence.

Return Value:

TMediaSequence* -The new subsequence of the media sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::operator=

TTimeGraphic & operator =(const TTimeGraphic & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly.

Parameters:

const TTimeGraphic & source -The object to copy.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call this function directly.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the versions don't match.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeGraphic::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.