KFbxStreamOptions Class Reference

#include <kfbxstreamoptions.h>

Inherits KFbxObject.

Inherited by KFbxStreamOptions3dsReader, KFbxStreamOptions3dsWriter, KFbxStreamOptionsColladaReader, KFbxStreamOptionsColladaWriter, KFbxStreamOptionsDxfReader, KFbxStreamOptionsDxfWriter, KFbxStreamOptionsFbxReader, KFbxStreamOptionsFbxWriter, KFbxStreamOptionsObjReader, and KFbxStreamOptionsObjWriter.

Inheritance diagram for KFbxStreamOptions:

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 59 of file kfbxstreamoptions.h.

Public Member Functions
virtual void	Reset ()
	Reset all the options to default value.
KFbxProperty	GetOption (int n)
	Get Stream Option by index.
KFbxProperty	GetOption (int n) const
	Get Stream Option by index.
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 (int n, KFbxProperty pProperty)
	Set a Stream Option by index and by a Property (KFbxProperty).
int	GetOptionCount () const
	Get the number of Stream Options.
void	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, KFbxStreamOptionsObjReader, and KFbxStreamOptionsObjWriter.

KFbxProperty GetOption

(

int

n

)

[inline]

Get Stream Option by index.

Parameters:

n

The index of the Stream Option

Returns:

A KFbxProperty if the range is valid.

Remarks:

In the last case, an assert is raised

Definition at line 75 of file kfbxstreamoptions.h.

References KFbxObject::GetProperty(), KFbxObject::GetPropertyCount(), and K_ASSERT_MSG_NOW.

Referenced by KFbxStreamOptionsDxfReader::SetCreateRootNode(), and KFbxStreamOptionsDxfReader::SetWeldVertices().

KFbxProperty GetOption

(

int

n

)

const [inline]

Get Stream Option by index.

Parameters:

n

The index of the Stream Option

Returns:

A KFbxProperty if the range is valid.

Remarks:

In the last case, an assert is raised

Definition at line 82 of file kfbxstreamoptions.h.

References KFbxObject::GetProperty(), KFbxObject::GetPropertyCount(), and K_ASSERT_MSG_NOW.

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

KFbxProperty GetOption

(

const char *

pName

)

Get a Stream Option by Stream Option Name.

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 104 of file kfbxstreamoptions.h.

References FbxTypeOf(), 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 121 of file kfbxstreamoptions.h.

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

bool SetOption	(	int	n,
		KFbxProperty	pProperty
	)

Set a Stream Option by index and by a Property (KFbxProperty).

Parameters:

	n	Index of the Stream Option.
	pProperty	Property containing the value to be set.

Returns:

true if the Property has been set, otherwise false.

int GetOptionCount

(

)

const [inline]

Get the number of Stream Options.

Returns:

Total number of Stream Options

Definition at line 143 of file kfbxstreamoptions.h.

References KFbxObject::GetPropertyCount().

void CopyFrom

(

const KFbxStreamOptions *

pKFbxStreamOptionsSrc

)

Copies the properties of another KFbxStreamOptions.

Parameters:

pKFbxStreamOptionsSrc

Contains the properties to be copied