Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLImageLibrary Class Reference

#include <XSIImageLibrary.h>

Inheritance diagram for CSLImageLibrary::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Class CSLImageLibrary

Defines a collection of images

Note:
This template was introduced in dotXSI Version 3.6


Constructor & Destructor Documentation

CSLImageLibrary::CSLImageLibrary CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template


Member Function Documentation

CSLImage * CSLImageLibrary::AddImage  
 

Adds an Image to the Image list

Returns:
CSLImage Pointer to the newly added Image

SI_Error CSLImageLibrary::ClearImages  
 

Removes all connections points from the Image list

Returns:
SI_Error Whether or not the list could be cleared

CSLImage * CSLImageLibrary::ConnectImage CSLImage   in_pNewImage
 

Adds an exisiting Image to the Image list

Parameters:
in_pToConnect  Pointer to the Image to add
Returns:
The added Image or null if it already exists in the list

CSLImage * CSLImageLibrary::FindImage SI_Char *    in_szName
 

Searches for a given Image

Parameters:
in_szImageName  Name of the Image to look for
Returns:
CSLImage Pointer to the Image or null if it cannot be found

SI_Int CSLImageLibrary::GetImageCount  
 

Gets the total number of Images

Returns:
SI_Int Number of Images

CSLImage ** CSLImageLibrary::GetImageList  
 

Gets a pointer to the internally-stored Image pointer list

Returns:
CSLImage Pointer to the list

CSLAnimatableType * CSLImageLibrary::ParameterFromName SI_Char *    in_szName [virtual]
 

Return a proxy to the specified parameter.

Parameters:
in_szName  Name of the parameter
Returns:
CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

SI_Error CSLImageLibrary::RemoveImage CSLImage   in_pImage
 

Removes an Image from the Image list

Parameters:
in_pToRemove  Pointer to the Image to remove
Returns:
SI_Error Whether or not the Image could be removed

SI_Error CSLImageLibrary::RemoveImage SI_Int    in_nIndex
 

Removes an Image from the Image list

Parameters:
in_nIndex  Index of the Image to remove
Returns:
SI_Error Whether or not the Image could be removed

SI_Error CSLImageLibrary::Synchronize   [virtual]
 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLImageLibrary::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_IMAGE_LIBRARY

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.