Class: TGraphicSequence

Declaration: VideoSequence.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTimeGraphic

Inherited By:

TQuickTimeVideoSequence

Purpose:

Adds the concept of a sequence of discrete graphics to TTimeGraphic. Provides an interface for accessing the component MGraphics.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive for graphic (video) data encoded by a specific format (for example, QuickTime).

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TGraphicSequence::TGraphicSequence

TGraphicSequence ()
TGraphicSequence (const TGraphicSequence &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and when creating an empty sequence.
Call this function directly.

Parameters:

Takes no parameters.
const TGraphicSequence & -The sequence to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::~TGraphicSequence

virtual ~ TGraphicSequence ()

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: TGraphicSequence::GetNumberOfGraphics

virtual unsigned long GetNumberOfGraphics () const

Interface Category:

API.

Purpose:

Returns the number of graphics that are in the sequence.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

unsigned long -The number of graphics in the sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::GetCurrentGraphicIndex

virtual GraphicIndex GetCurrentGraphicIndex () const

Interface Category:

API.

Purpose:

Returns the index of the current graphic.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

TGraphicSequence::GraphicIndex -The current graphic index.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::SetCurrentGraphicIndex

virtual void SetCurrentGraphicIndex (GraphicIndex index)

Interface Category:

API.

Purpose:

Sets the index of the current graphic. The index is zero-based, and can be equal to or less than the number of graphics in the sequence.

Calling Context:

Call this function directly.

Parameters:

GraphicIndex index -The new index.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::GetCurrentGraphic

virtual MGraphic * GetCurrentGraphic () const

Interface Category:

API.

Purpose:

Returns a pointer to the MGraphic that corresponds to the current index.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

MGraphic* -The current graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::IsReadOnly

virtual bool IsReadOnly () const

Interface Category:

API.

Purpose:

Determines if the sequence is read-only.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if the sequence is read-only.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::Append

virtual void Append (MGraphic * graphicToAdopt, const TTime & duration)

Interface Category:

API.

Purpose:

Appends the given graphic to the end of the graphic sequence.

Calling Context:

Call this function directly.

Parameters:

MGraphic * graphicToAdopt -The graphic to append to the sequence.
const TTime & duration -The duration of the appended graphic.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::GetCurrentGraphicDuration

virtual void GetCurrentGraphicDuration (TTime & duration) const

Interface Category:

API.

Purpose:

Returns the duration of the current graphic.

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: TGraphicSequence::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: TGraphicSequence::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: TGraphicSequence::GetLooseFitBounds

virtual TGRect GetLooseFitBounds (const TGrafPort * =NIL) const

Interface Category:

API.

Purpose:

Returns the current loose fit bounds.

Calling Context:

Call this function directly.

Parameters:

const TGrafPort * =NIL -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: TGraphicSequence::TransformBy

virtual void TransformBy (const TGrafMatrix &)

Interface Category:

API.

Purpose:

Transforms this TGraphicSequence 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: TGraphicSequence::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 TTime to set to the duration.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::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 place to put the list of types to be returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::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: TGraphicSequence::CreateSubrange

virtual TMediaSequence * CreateSubrange (const TMediaRange & range) const

Interface Category:

API.

Purpose:

Creates 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: TGraphicSequence::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 -The time returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicSequence::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: TGraphicSequence::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: TGraphicSequence::operator=

TGraphicSequence & operator =(const TGraphicSequence & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly.

Parameters:

const TGraphicSequence & 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: TGraphicSequence::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: TGraphicSequence::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: TGraphicSequence::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.