KFbxStreamOptions Class Reference

#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 line 52 of file kfbxstreamoptions.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 (KFbxProperty pProperty)
	Set a Stream Option by a Property (KFbxProperty).
bool	CopyFrom (const KFbxStreamOptions *pKFbxStreamOptionsSrc)
	Copies the properties of another KFbxStreamOptions.

---

Member Function Documentation

virtual void Reset

(

)

[virtual]

Reset all the options to default value.

Reimplemented in KFbxStreamOptions3dsReader, KFbxStreamOptions3dsWriter, KFbxStreamOptionsColladaReader, KFbxStreamOptionsColladaWriter, KFbxStreamOptionsDxfReader, KFbxStreamOptionsFbxReader, KFbxStreamOptionsFbxWriter, KFbxStreamOptionsMotionReader, KFbxStreamOptionsMotionWriter, KFbxStreamOptionsObjReader, and KFbxStreamOptionsObjWriter.

KFbxProperty GetOption

(

KString &

pName

)

Get a Stream Option by Stream Option Name.

Parameters:

pName

The name of the Stream Option

Returns:

A KFbxProperty if the name is valid.

Remarks:

In the last case, an assert is raised

Referenced by KFbxStreamOptionsMotionWriter::GetFrameCount(), KFbxStreamOptionsMotionReader::GetFrameCount(), KFbxStreamOptionsMotionWriter::GetFrameRate(), KFbxStreamOptionsMotionReader::GetFrameRate(), KFbxStreamOptionsMotionWriter::GetStart(), KFbxStreamOptionsMotionReader::GetStart(), KFbxStreamOptionsMotionWriter::SetFrameCount(), KFbxStreamOptionsMotionReader::SetFrameCount(), KFbxStreamOptionsMotionWriter::SetStart(), and KFbxStreamOptionsMotionReader::SetStart().

KFbxProperty GetOption

(

const char *

pName

)

Get a Stream Option by Stream Option Name.

Parameters:

pName

The name of the Stream Option

Returns:

A KFbxProperty if 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:

true if the Stream Option was found and the value has been set.

Definition at line 84 of file kfbxstreamoptions.h.

References KFbxProperty::GetPropertyDataType(), KFbxDataType::GetType(), KFbxProperty::IsValid(), and KFbxProperty::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:

true if the Stream Option was found and the value has been set.

Definition at line 101 of file kfbxstreamoptions.h.

References KFbxProperty::GetPropertyDataType(), KFbxDataType::GetType(), KFbxProperty::IsValid(), and KFbxProperty::Set().

bool SetOption

(

KFbxProperty

pProperty

)

Set a Stream Option by a Property (KFbxProperty).

Parameters:

pProperty

Property containing the value to be set.

Returns:

true if the Property has been set, otherwise false.

bool CopyFrom

(

const KFbxStreamOptions *

pKFbxStreamOptionsSrc

)

Copies the properties of another KFbxStreamOptions.

Parameters:

pKFbxStreamOptionsSrc

Contains the properties to be copied