CSLImageLibrary Class Reference

#include <XSIImageLibrary.h>

Inheritance diagram for CSLImageLibrary:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLImageLibrary (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLImageLibrary ()
  Destructor.
ETemplateType  Type ()
SI_Error  Synchronize ()
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
CSLImage *  AddImage ()
SI_Error  RemoveImage (SI_Int in_nIndex)
SI_Error  RemoveImage (CSLImage *in_pToRemove)
SI_Error  ClearImages ()
CSLImage *  ConnectImage (CSLImage *in_pToConnect)
CSLImage **  GetImageList ()
SI_Int  GetImageCount ()
CSLImage *  FindImage (SI_Char *in_szImageName)

Detailed Description

Base class to define a collection of images for dotXSI 5.0+ (see the XSI_ImageLibrary template reference).
Note:
This template was introduced in dotXSI Version 3.6

Constructor & Destructor Documentation

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

ETemplateType Type (  )  [inline, virtual]

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_IMAGE_LIBRARY

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* 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.

CSLImage* AddImage (  ) 

Adds an Image to the Image list

Returns:
CSLImage Pointer to the newly added Image

SI_Error 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 RemoveImage ( CSLImage *  in_pToRemove  ) 

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 ClearImages (  ) 

Removes all connections points from the Image list

Returns:
SI_Error Whether or not the list could be cleared

CSLImage* ConnectImage ( CSLImage *  in_pToConnect  ) 

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** GetImageList (  ) 

Gets a pointer to the internally-stored Image pointer list

Returns:
CSLImage Pointer to the list

SI_Int GetImageCount (  ) 

Gets the total number of Images

Returns:
SI_Int Number of Images

CSLImage* FindImage ( SI_Char *  in_szImageName  ) 

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

The documentation for this class was generated from the following file: