#include<kfbxstreamoptions.h>

Inheritance diagram for KFbxStreamOptions:

[legend]

List of all members.

Detailed Description

This class provides the structure to build a KFbx Stream Option.

This class is a composite class that contains stream options management services. The content of a Kfbx Stream Option is stored in a property (KFbxProperty).

Definition at line52of filekfbxstreamoptions.h.

Public Member Functions
virtual void	Reset()
	Reset all the options to default value.
KFbxProperty	GetOption(KString&pName)
	Get a Stream Option by Stream Option Name.
KFbxProperty	GetOption(const char *pName)
	Get a Stream Option by Stream Option Name.
template<class T>
bool	SetOption(KString&pName, T const&pValue)
	Set a Stream Option by Stream Option Name and a Value.
template<class T>
bool	SetOption(const char *pName, T const&pValue)
	Set a Stream Option by Stream Option Name and a Value.
bool	SetOption(KFbxPropertypProperty)
	Set a Stream Option by a Property (KFbxProperty).
bool	CopyFrom(constKFbxStreamOptions*pKFbxStreamOptionsSrc)
	Copies the properties of anotherKFbxStreamOptions.

Member Function Documentation

virtual void Reset

(

)

[virtual]

Reset all the options to default value.

Reimplemented inKFbxStreamOptions3dsReader,KFbxStreamOptions3dsWriter,KFbxStreamOptionsColladaReader,KFbxStreamOptionsColladaWriter,KFbxStreamOptionsDxfReader,KFbxStreamOptionsFbxReader,KFbxStreamOptionsFbxWriter,KFbxStreamOptionsMotionReader,KFbxStreamOptionsMotionWriter,KFbxStreamOptionsObjReader, andKFbxStreamOptionsObjWriter.

KFbxPropertyGetOption

(

KString&

pName

)

Get a Stream Option by Stream Option Name.

Parameters:

pName

The name of the Stream Option

Returns:

AKFbxPropertyif the name is valid.

Remarks:

In the last case, an assert is raised

Referenced byKFbxStreamOptionsMotionWriter::GetFrameCount(),KFbxStreamOptionsMotionReader::GetFrameCount(),KFbxStreamOptionsMotionWriter::GetFrameRate(),KFbxStreamOptionsMotionReader::GetFrameRate(),KFbxStreamOptionsMotionWriter::GetStart(),KFbxStreamOptionsMotionReader::GetStart(),KFbxStreamOptionsDxfReader::SetCreateRootNode(),KFbxStreamOptionsMotionWriter::SetFrameCount(),KFbxStreamOptionsMotionReader::SetFrameCount(),KFbxStreamOptionsMotionWriter::SetStart(),KFbxStreamOptionsMotionReader::SetStart(), andKFbxStreamOptionsDxfReader::SetWeldVertices().

KFbxPropertyGetOption

(

const char *

pName

)

Get a Stream Option by Stream Option Name.

Parameters:

pName

The name of the Stream Option

Returns:

AKFbxPropertyif the name is valid.

Remarks:

In the last case, an assert is raised

bool SetOption	(	KString&	pName,
		T const&	pValue
	)			[inline]

Set a Stream Option by Stream Option Name and a Value.

Parameters:

	pName	Name of the option where a change is needed.
	pValue	Value to be set.

Returns:

trueif the Stream Option was found and the value has been set.

Definition at line84of filekfbxstreamoptions.h.

ReferencesKFbxProperty::GetPropertyDataType(),KFbxDataType::GetType(),KFbxProperty::IsValid(), andKFbxProperty::Set().

bool SetOption	(	const char *	pName,
		T const&	pValue
	)			[inline]

Set a Stream Option by Stream Option Name and a Value.

Parameters:

	pName	Name of the option where a change is needed.
	pValue	Value to be set.

Returns:

trueif the Stream Option was found and the value has been set.

Definition at line101of filekfbxstreamoptions.h.

ReferencesKFbxProperty::GetPropertyDataType(),KFbxDataType::GetType(),KFbxProperty::IsValid(), andKFbxProperty::Set().

bool SetOption

(

KFbxProperty

pProperty

)

Set a Stream Option by a Property (KFbxProperty).

Parameters:

pProperty

Property containing the value to be set.

Returns:

trueif the Property has been set, otherwisefalse.

bool CopyFrom

(

constKFbxStreamOptions*

pKFbxStreamOptionsSrc

)

Copies the properties of anotherKFbxStreamOptions.

Parameters:

pKFbxStreamOptionsSrc

Contains the properties to be copied