MFalloffFunction::ReturnValue Struct Reference

Return Value data type for a falloff function. More...

#include <MFnFalloffData.h>

Public Member Functions
	ReturnValue ()
	Default constructor.
	ReturnValue (const MBufferIdentifier &bufferId, Requirement, CachedIndicator)
	ReturnValue are created within a fallofffunction to indicate wehre the buffer was written and requirement for geometry. More...
	ReturnValue (ReturnValue &&)
	ReturnValue move constructor.
	~ReturnValue ()
	ReturnValue Destructor.
MBufferIdentifier	getBufferId () const
	Return buffer Identifier. More...
Requirement	getRequirement () const
	Return requirement. More...
CachedIndicator	getCachedIndicator () const
	Return cached indicator. More...

Detailed Description

Return Value data type for a falloff function.

ReturValue indicate the buffer with the bufferId it indicated if it require Original Geometry or the Current geometry from the current geom deformer it returns as well if the buffer is intact from last evaluation "Cached"

Constructor & Destructor Documentation

ReturnValue	(	const MBufferIdentifier &	bufferId,
		Requirement	req,
		CachedIndicator	cached
	)

ReturnValue are created within a fallofffunction to indicate wehre the buffer was written and requirement for geometry.

Parameters

[in]	bufferId	is a unique identifier for the given deformation stack and can be use to access weight buffer and other information through MFalloffContext object.
[in]	req	indicate if the current falloff function need the current geometry (input from the deformer), the original geometry (connected as original geometry on the deformer) or none of them. Note that requiring current geometry will result in weight computation at every input vertex deformation. Requiring OriginalGeometry will trigger a weight recomputation only when original geometry change on the targeted deformer.
[in]	cached	indicated if the buffer is unchanged from last evaluation. Falloff use a different technic to evaluate. it triggers an evaluation of the entire weight falloff network even if only one fall off changed. Performance wise it is important to indicate if weight is the same to avoid useless recomputation.

Member Function Documentation

MBufferIdentifier getBufferId

(

)

const

Return buffer Identifier.

Returns

bufferId stored in this object.

MFalloffFunction::ReturnValue::Requirement getRequirement

(

)

const

Return requirement.

Returns

The geometry requirement stored in this object.

MFalloffFunction::ReturnValue::CachedIndicator getCachedIndicator

(

)

const

Return cached indicator.

Returns

The cached indicator in this object.

---

The documentation for this struct was generated from the following files:

• MFnFalloffData.h
• MFnFalloffData.cpp