INavigationPoints.h

//========================================================================================
// 
// $File$
// 
// Owner: wtislar
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __INavigationPoints__
#define __INavigationPoints__

#include "IPMUnknown.h"
#include "MediaID.h"

class NamedUint32AttributeList;

class INavigationPoints : public IPMUnknown
{

public:
 enum { kDefaultIID = IID_INAVIGATIONPOINTS };
 
 enum { kInvalidTime = 0xffffffff };
 enum { kInvalidNavigationPointId = 0xffffffff };
 
 typedef K2Vector<uint32> NavigationPointsIndexList;
 
 class NavigationPoint
 {
 public:

 NavigationPoint()
 : fId(kInvalidNavigationPointId), fTime(kInvalidTime) {}

 NavigationPoint( uint32 id, const PMString & displayName, uint32 time )
 : fId(id),
 fDisplayName(displayName),
 fTime(time){}

 NavigationPoint( const NavigationPoint& orig ) { Set( orig ); }

 //----------OPERATORS---------------
 
 NavigationPoint& operator = (const NavigationPoint &copy)
 { Set(copy); return *this; }

 inline bool operator == (const NavigationPoint &np) const
 { return fId == np.fId &&
 fDisplayName == np.fDisplayName &&
 fTime == np.fTime; }

 inline bool operator != (const NavigationPoint &np) const
 { return (!(*this == np)); }
 
 uint32 fId; // Identifier unique to the list.
 PMString fDisplayName; // Name to display in the UI.
 uint32 fTime; // A video time in 1/100s seconds.
 
 private:
 void Set( const NavigationPoint & copy )
 { fId = copy.fId; fDisplayName = copy.fDisplayName; fTime = copy.fTime; } 
 }; // end NavigationPoint class 

 
 virtual int32 AddPoint( uint32 time, bool16 atEnd = kFalse ) = 0;
 
 virtual bool CanRemovePoint( int32 indexAt ) const = 0;

 virtual bool DoesNavigationPointExist( uint32 navPointID ) const = 0;

 virtual bool GetDisplayName( uint32 navPointID, PMString & outDisplayName ) const = 0;
 
 virtual bool GetNavigationPointById( uint32 navPointID, INavigationPoints::NavigationPoint & outNavPoint ) const = 0;

 virtual bool GetNextNavigationPoint( INavigationPoints::NavigationPoint & outNavPoint ) = 0;

 virtual bool GetNthNavigationPoint( uint32 index, INavigationPoints::NavigationPoint & outNavPoint ) const = 0;

 virtual bool GetNthNavigationPointTime( uint32 index, PMReal & outTime ) const = 0;
 
 virtual uint32 GetNumberOfNavigationPoints() const = 0;

 virtual uint32 GetTime( uint32 navPointID ) const = 0;
 
 virtual ErrorCode RemovePoints( const INavigationPoints::NavigationPointsIndexList & indexList ) = 0;

 virtual void ResetIterator() = 0;
 
 virtual ErrorCode SetDisplayName( uint32 navPointID, const PMString & inDisplayName ) = 0;

 virtual ErrorCode SetTime( uint32 navPointID, PMReal time ) = 0;
 
 virtual ErrorCode ResetId( uint32 oldNavPointID, uint32 newNavPointID ) = 0;
 
 virtual ErrorCode AddPoints( NamedUint32AttributeList & list ) = 0; 
 
}; // end INavigationPoints interface


#endif // __INavigationPoints__