Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
DOM::ILayer Class Referenceabstract

Defines the interface that represents a layer in the timeline. More...

#include <ILayer.h>

Inheritance diagram for DOM::ILayer:

Public Member Functions

virtual FCM::Result _FCMCALL GetName (FCM::StringRep16 *ppName)=0
 Returns the name of the layer. More...
 
virtual FCM::Result _FCMCALL IsVisible (FCM::Boolean &isVisible)=0
 Tests if the layer is visible or not. More...
 
virtual FCM::Result _FCMCALL GetParentLayer (PILayer &pParentLayer)=0
 Get Parent layer for the current layer. More...
 
virtual FCM::Result _FCMCALL GetLayerType (FCM::PIFCMUnknown &pLayerType)=0
 Gets the type associated with this layer. The type determines whether it is a folder, mask, guide, or normal. More...
 

Detailed Description

Defines the interface that represents a layer in the timeline.

Member Function Documentation

virtual FCM::Result _FCMCALL DOM::ILayer::GetLayerType ( FCM::PIFCMUnknown &  pLayerType)
pure virtual

Gets the type associated with this layer. The type determines whether it is a folder, mask, guide, or normal.

Parameters
pLayerType(OUT) The type of the layer. This can be queried for one of the following interfaces: ILayerFolder, ILayerNormal, ILayerMask and ILayerGuide.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
See also
DOM::Layer::ILayerFolder
DOM::Layer::ILayerNormal
DOM::Layer::ILayerMask
DOM::Layer::ILayerGuide
virtual FCM::Result _FCMCALL DOM::ILayer::GetName ( FCM::StringRep16 *  ppName)
pure virtual

Returns the name of the layer.

Parameters
ppName(OUT) Name of the layer
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
Note
The memory allocated for 'ppName' in this function must be freed by the caller using IFCMCalloc::Free().
virtual FCM::Result _FCMCALL DOM::ILayer::GetParentLayer ( PILayer &  pParentLayer)
pure virtual

Get Parent layer for the current layer.

Parameters
pParentLayer(OUT) Parent Layer for the current layer Otherwise it is set to NULL
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL DOM::ILayer::IsVisible ( FCM::Boolean &  isVisible)
pure virtual

Tests if the layer is visible or not.

Parameters
isVisible(OUT) True if all objects in the layer are visible;false if any is hidden.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
The documentation for this class was generated from the following file: