DX::IDXModelInfo Struct Reference

#include <IDXModelInfo.h>

Inherits DX::IDXModelOwned, and DX::IDXUserData.

Collaboration diagram for DX::IDXModelInfo:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const wchar_t *DXMCALL GetTitle () const =0
virtual const wchar_t *DXMCALL GetSummary () const =0
virtual uint DXMCALL GetNumTags () const =0
virtual DXError DXMCALL GetTag (uint index, IDXTagPtr *out) const =0
virtual DXError DXMCALL GetTags (IDXTagArray out) const =0
virtual DXError DXMCALL GetTags (uint start, uint count, IDXTagArray out) const =0
virtual const wchar_t *DXMCALL GetThumbnail () const =0
virtual DXError DXMCALL SetTitle (const wchar_t *title)=0
virtual DXError DXMCALL SetSummary (const wchar_t *summary)=0
virtual DXError DXMCALL SetThumbnail (const wchar_t *filename)=0
virtual DXError DXMCALL AddTag (const wchar_t *tag, IDXTagPtr *out=0)=0
virtual DXError DXMCALL RemoveTag (uint index)=0
virtual DXError DXMCALL RemoveTag (uint start, uint count)=0
virtual DXError DXMCALL RemoveTag (const wchar_t *tag)=0
virtual void DXMCALL ClearTags ()=0


Detailed Description

IDXModelInfo contains metadata for a model, including summary, tags and title.

Member Function Documentation

virtual DXError DXMCALL DX::IDXModelInfo::AddTag ( const wchar_t *  tag,
IDXTagPtr *  out = 0 
) [pure virtual]

Add a new tag to this IDXModel

Parameters:
tag The new tag to add
Returns:
Error_NullParam if tag was null.
Error_Duplicate if the tag is already present.
Error_Success if the tag was added.

virtual void DXMCALL DX::IDXModelInfo::ClearTags (  )  [pure virtual]

Remove all tags from the IDXModelInfo

virtual uint DXMCALL DX::IDXModelInfo::GetNumTags (  )  const [pure virtual]

Get the number of tags currently on this IDXModel

Returns:
The number of tags.

virtual const wchar_t* DXMCALL DX::IDXModelInfo::GetSummary (  )  const [pure virtual]

The current summary for this model.

Returns:
The summary that is being used.

virtual DXError DXMCALL DX::IDXModelInfo::GetTag ( uint  index,
IDXTagPtr *  out 
) const [pure virtual]

Get the tag at an index.

Parameters:
index The index of the tag to retrieve.
out A pointer to an IDXTagPtr to receive the tag.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was not less than the number of tags on the model.
Error_Success if the tag was returned.

virtual DXError DXMCALL DX::IDXModelInfo::GetTags ( uint  start,
uint  count,
IDXTagArray  out 
) const [pure virtual]

Get a block of IDXTags.

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of IDXTagPtr of length at least count.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModelInfo::GetTags ( IDXTagArray  out  )  const [pure virtual]

Get all tags that are on this model.

Parameters:
out A user allocated array of IDXTagPtr of length at least GetNumTags.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual const wchar_t* DXMCALL DX::IDXModelInfo::GetThumbnail (  )  const [pure virtual]

Get the thumbnail filename.

Returns:
The name of the thumbnail file to use.

virtual const wchar_t* DXMCALL DX::IDXModelInfo::GetTitle (  )  const [pure virtual]

The current title for this model.

Returns:
The title that is being used for this model.

virtual DXError DXMCALL DX::IDXModelInfo::RemoveTag ( const wchar_t *  tag  )  [pure virtual]

Remove a tag from the taglist

Parameters:
tag The tag to remove. (Compared based on content, not on address)
Returns:
Error_NullParam if tag was null.
Error_NotFound if the tag was not found.
Error_Success if the tag was removed.

virtual DXError DXMCALL DX::IDXModelInfo::RemoveTag ( uint  start,
uint  count 
) [pure virtual]

Remove a range of tags.

Parameters:
start The index of the first tag to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXModelInfo::RemoveTag ( uint  index  )  [pure virtual]

Remove a tag from the taglist

Parameters:
index The index of the tag to remove.
Returns:
Error_OutOfRange if index was not less than the number of tags on the model.
Error_Success if the tag was removed from the model.

virtual DXError DXMCALL DX::IDXModelInfo::SetSummary ( const wchar_t *  summary  )  [pure virtual]

Set the summary that will be displayed in the editor.

Parameters:
summary The new summary to use.
Returns:
Error_NullParam if summary was null.
Error_Success if the summary was changed.

virtual DXError DXMCALL DX::IDXModelInfo::SetThumbnail ( const wchar_t *  filename  )  [pure virtual]

Set the thumbnail filename for this model.

Parameters:
filename The filename to use.
Returns:
Error_NullParam if filename was null.
Error_Success if the thumbnail was set.

virtual DXError DXMCALL DX::IDXModelInfo::SetTitle ( const wchar_t *  title  )  [pure virtual]

Set the title of the model that will appear in the editor

Parameters:
title The new title to use for the model
Returns:
Error_NullParam if title was null.
Error_Success if the title was changed.


Generated on Wed Jun 17 17:24:51 2009 for DXMesh API by  doxygen 1.5.7.1