TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iMaterialLibrary Struct Referenceabstract
Inheritance diagram for iMaterialLibrary:
iUnknown

Detailed Description

Material library interface.

Public Member Functions

virtual tMaterialLibrarySinkLstGetSinkList () const =0
 Get the sink list. {Property}. More...
 
virtual ni::tBool Copy (const iMaterialLibrary *apSrc, tBool abCloneMats)=0
 Copy the material library. More...
 
virtual iMaterialLibraryClone (tBool abCloneMats) const =0
 Clone the material library. More...
 
virtual ni::tBool ClearMaterials ()=0
 Remove all materials. More...
 
virtual ni::tBool AddMaterial (ni::iMaterial *apMaterial)=0
 Add a material. More...
 
virtual ni::tBool RemoveMaterial (ni::iMaterial *apMaterial)=0
 Remove a material. More...
 
virtual ni::tU32 GetNumMaterials () const =0
 Get the number of materials. {Property}. More...
 
virtual ni::iMaterialGetMaterial (ni::tU32 anIndex) const =0
 Get the material at the specified index. {Property}. More...
 
virtual ni::iMaterialGetMaterialFromName (ni::iHString *ahspName) const =0
 Get the material from the specified name. {Property}. More...
 
virtual ni::tU32 GetMaterialIndex (ni::iMaterial *apMaterial) const =0
 Get the index of the specified material. {Property}. More...
 
virtual ni::tBool SerializeDataTable (ni::iDataTable *apDT, tMaterialSerializeFlags aFlags)=0
 Serialize the library in a datatable. More...
 
virtual ni::tBool SerializeFile (ni::iFile *apFile, tMaterialSerializeFlags aFlags)=0
 Serialize the library in a file. More...
 
virtual void SetBasePath (iHString *ahspBasePath)=0
 Set the material library's base path. {Property}. More...
 
virtual iHStringGetBasePath () const =0
 Get the material library's base path. {Property}. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual tMaterialLibrarySinkLst* GetSinkList ( ) const
pure virtual

Get the sink list. {Property}.

virtual ni::tBool Copy ( const iMaterialLibrary apSrc,
tBool  abCloneMats 
)
pure virtual

Copy the material library.

Parameters
apSrcis the source library to copy
abCloneMatssets whether the materials will be cloned, or just their pointer transfered.
virtual iMaterialLibrary* Clone ( tBool  abCloneMats) const
pure virtual

Clone the material library.

virtual ni::tBool ClearMaterials ( )
pure virtual

Remove all materials.

virtual ni::tBool AddMaterial ( ni::iMaterial apMaterial)
pure virtual

Add a material.

virtual ni::tBool RemoveMaterial ( ni::iMaterial apMaterial)
pure virtual

Remove a material.

virtual ni::tU32 GetNumMaterials ( ) const
pure virtual

Get the number of materials. {Property}.

virtual ni::iMaterial* GetMaterial ( ni::tU32  anIndex) const
pure virtual

Get the material at the specified index. {Property}.

virtual ni::iMaterial* GetMaterialFromName ( ni::iHString ahspName) const
pure virtual

Get the material from the specified name. {Property}.

virtual ni::tU32 GetMaterialIndex ( ni::iMaterial apMaterial) const
pure virtual

Get the index of the specified material. {Property}.

virtual ni::tBool SerializeDataTable ( ni::iDataTable apDT,
tMaterialSerializeFlags  aFlags 
)
pure virtual

Serialize the library in a datatable.

virtual ni::tBool SerializeFile ( ni::iFile apFile,
tMaterialSerializeFlags  aFlags 
)
pure virtual

Serialize the library in a file.

virtual void SetBasePath ( iHString ahspBasePath)
pure virtual

Set the material library's base path. {Property}.

virtual iHString* GetBasePath ( ) const
pure virtual

Get the material library's base path. {Property}.