OpenSubdiv::OPENSUBDIV_VERSION::Far Namespace Reference

Classes
class	LimitStencil
	Limit point stencil descriptor. More...
class	LimitStencilTable
	Table of limit subdivision stencils. More...
class	LimitStencilTableFactory
	A specialized factory for LimitStencilTable. More...
class	PatchDescriptor
	Describes the type of a patch. More...
class	PatchMap
	An quadtree-based map connecting coarse faces to their sub-patches. More...
struct	PatchParam
	Local patch parameterization descriptor. More...
class	PatchTable
	Container for arrays of parametric patches. More...
class	PatchTableFactory
class	PrimvarRefiner
	Applies refinement operations to generic primvar data. More...
class	PtexIndices
	Object used to compute and query ptex face indices. More...
class	Stencil
	Vertex stencil descriptor. More...
class	StencilTable
	Table of subdivision stencils. More...
class	StencilTableFactory
	A specialized factory for StencilTable. More...
struct	TopologyDescriptor
	Descriptor for raw topology data, provided as a convenience with a corresponding Factory. It should be functionally complete and simple to use, but for more demanding situations, writing a custom Factory is likely warranted. More...
class	TopologyLevel
	TopologyLevel is an interface for accessing data in a specific level of a refined topology hierarchy. Instances of TopologyLevel are created and owned by a TopologyRefiner, which will return const-references to them. Such references are only valid during the lifetime of TopologyRefiner that created and returned them, and only for a given refinement, i.e. if the TopologyRefiner is re-refined, any references to TopoologyLevels are invalidated. More...
class	TopologyRefiner
	Stores topology data for a specified set of refinement options. More...
class	TopologyRefinerFactory
	Factory for constructing TopologyRefiners from specific mesh classes. More...
class	TopologyRefinerFactoryBase
	Private base class of Factories for constructing TopologyRefiners. More...

Typedefs
typedef void(*	ErrorCallbackFunc) (ErrorType err, const char *message)
typedef void(*	WarningCallbackFunc) (const char *message)
	Sets the warning callback function (default is "printf") More...
typedef Vtr::ConstArray< PatchDescriptor >	ConstPatchDescriptorArray
typedef std::vector< PatchParam >	PatchParamTable
typedef Vtr::Array< PatchParam >	PatchParamArray
typedef Vtr::ConstArray< PatchParam >	ConstPatchParamArray
typedef Vtr::Index	Index
typedef Vtr::LocalIndex	LocalIndex
typedef Vtr::IndexArray	IndexArray
typedef Vtr::LocalIndexArray	LocalIndexArray
typedef Vtr::ConstIndexArray	ConstIndexArray
typedef Vtr::ConstLocalIndexArray	ConstLocalIndexArray

Enumerations
enum	ErrorType {   FAR_NO_ERROR,   FAR_FATAL_ERROR,   FAR_INTERNAL_CODING_ERROR,   FAR_CODING_ERROR,   FAR_RUNTIME_ERROR }

Functions
void	SetErrorCallback (ErrorCallbackFunc func)
	Sets the error callback function (default is "printf") More...
void	Error (ErrorType err)
	Sends an OSD error. More...
void	Error (ErrorType err, const char *format,...)
	Sends an OSD error with a message. More...
void	SetWarningCallback (WarningCallbackFunc func)
	Sets the warning callback function (default is "printf") More...
void	Warning (const char *format,...)
	Sends an OSD warning message. More...
bool	IndexIsValid (Index index)

Typedef Documentation

typedef Vtr::ConstIndexArray ConstIndexArray

Definition at line 47 of file types.h.

typedef Vtr::ConstLocalIndexArray ConstLocalIndexArray

Definition at line 48 of file types.h.

typedef Vtr::ConstArray<PatchDescriptor> ConstPatchDescriptorArray

Definition at line 151 of file patchDescriptor.h.

typedef Vtr::ConstArray<PatchParam> ConstPatchParamArray

Definition at line 126 of file patchParam.h.

typedef void(* ErrorCallbackFunc) (ErrorType err, const char *message)

Definition at line 43 of file error.h.

typedef Vtr::Index Index

Definition at line 41 of file types.h.

typedef Vtr::IndexArray IndexArray

Definition at line 44 of file types.h.

typedef Vtr::LocalIndex LocalIndex

Definition at line 42 of file types.h.

typedef Vtr::LocalIndexArray LocalIndexArray

Definition at line 45 of file types.h.

typedef Vtr::Array<PatchParam> PatchParamArray

Definition at line 125 of file patchParam.h.

typedef std::vector<PatchParam> PatchParamTable

Definition at line 123 of file patchParam.h.

typedef void(* WarningCallbackFunc) (const char *message)

Sets the warning callback function (default is "printf")

Definition at line 69 of file error.h.

Enumeration Type Documentation

enum ErrorType

Enumerator
FAR_NO_ERROR	No error. Move along.
FAR_FATAL_ERROR	Issue a fatal error and end the program.
FAR_INTERNAL_CODING_ERROR	Issue an internal programming error, but continue execution.
FAR_CODING_ERROR	Issue a generic programming error, but continue execution.
FAR_RUNTIME_ERROR	Issue a generic runtime error, but continue execution.

Definition at line 35 of file error.h.

Function Documentation

void OpenSubdiv::OPENSUBDIV_VERSION::Far::Error

(

ErrorType

err

)

Sends an OSD error.

Parameters

err	the error type

void OpenSubdiv::OPENSUBDIV_VERSION::Far::Error	(	ErrorType	err,
		const char *	format,
			...
	)

Sends an OSD error with a message.

Parameters

err	the error type
format	the format of the message (followed by arguments)

bool OpenSubdiv::OPENSUBDIV_VERSION::Far::IndexIsValid ( Index  index )

inline

Definition at line 50 of file types.h.

void OpenSubdiv::OPENSUBDIV_VERSION::Far::SetErrorCallback

(

ErrorCallbackFunc

func

)

Sets the error callback function (default is "printf")

Note

This function is not thread-safe !

Parameters

func	function pointer to the callback function

void OpenSubdiv::OPENSUBDIV_VERSION::Far::SetWarningCallback

(

WarningCallbackFunc

func

)

Sets the warning callback function (default is "printf")

Note

This function is not thread-safe !

Parameters

func	function pointer to the callback function

void OpenSubdiv::OPENSUBDIV_VERSION::Far::Warning	(	const char *	format,
			...
	)

Sends an OSD warning message.

Parameters

format

the format of the message (followed by arguments)