FalloffDataData Struct Reference

#include <c4d_falloffdata.h>

Detailed Description

Holds the data for FalloffData plugins.
Structure is read-only. The only exception is _userData, which can be set to whatever.
_userData must be checked before it is accessed as it can be reset to nullptr.
It is not normally reset to nullptr in-between switches to a different falloff, so it should be cleared in FalloffData::FreeFalloff if it has been set before.

Note

_userData is usually filled and used for speed within FalloffData::Sample.

Public Member Functions
	MAXON_OPERATOR_EQUALITY (FalloffDataData, _mat, _imat, _falloff, _scale, _strength, _size, _invert, _clamped, _visible, _useSpline, _nodemat, _inverseNodeMat, _offset, _axis, _slice, _torusRadius, _function, _spherical, _radius, _inverseRadius, _inverseFalloff, _animTime)
Bool	operator!= (const FalloffDataData &b)
Bool	SetMg (const Matrix &mg, Bool force=false)

Public Attributes
Matrix	_mat
Matrix	_imat
Float	_falloff
Float	_scale
Float	_strength
Vector	_size
Bool	_invert
Bool	_clamped
Bool	_visible
Bool	_useSpline
Matrix	_nodemat
Matrix	_inverseNodeMat
Vector	_offset
Int32	_axis
Float	_slice
Float	_torusRadius
Int32	_function
Bool	_spherical
Float	_radius
Float	_inverseRadius
Float	_inverseFalloff
Float	_animTime
maxon::GenericDataRef	_splineData
maxon::GenericDataRef	_userData

Member Function Documentation

MAXON_OPERATOR_EQUALITY()

MAXON_OPERATOR_EQUALITY	(	FalloffDataData	,
		_mat	,
		_imat	,
		_falloff	,
		_scale	,
		_strength	,
		_size	,
		_invert	,
		_clamped	,
		_visible	,
		_useSpline	,
		_nodemat	,
		_inverseNodeMat	,
		_offset	,
		_axis	,
		_slice	,
		_torusRadius	,
		_function	,
		_spherical	,
		_radius	,
		_inverseRadius	,
		_inverseFalloff	,
		_animTime
	)

operator!=()

Bool operator!=

(

const FalloffDataData &

b

)

Inequality operator. Checks if two FalloffDataDatas are different.

Parameters

[in]

b

The FalloffDataData to compare with.

Returns

true if the FalloffDataDatas are not equal, otherwise false.

SetMg()

Bool SetMg	(	const Matrix &	mg,
		Bool	force = false
	)

Member Data Documentation

_mat

Matrix _mat

Falloff matrix.

_imat

Matrix _imat

Inverse falloff matrix.

_falloff

Float _falloff

Falloff.

_scale

Float _scale

Scale.

_strength

Float _strength

Strength.

_size

Vector _size

Size.

_invert

Bool _invert

Invert.

_clamped

Bool _clamped

Clamped.

_visible

Bool _visible

Visible.

_useSpline

Bool _useSpline

Use spline.

_nodemat

Matrix _nodemat

The node's matrix.

_inverseNodeMat

Matrix _inverseNodeMat

The node's inverse matrix.

_offset

Vector _offset

Offset.

_axis

Int32 _axis

Axis orientation: FALLOFF_SHAPE_AXIS.

_slice

Float _slice

Slice 0-360°.

_torusRadius

Float _torusRadius

Torus radius.

_function

Int32 _function

Falloff function: FALLOFF_FUNCTION.

_spherical

Bool _spherical

Deprecated.

_radius

Float _radius

Deprecated.

_inverseRadius

Float _inverseRadius

Deprecated.

_inverseFalloff

Float _inverseFalloff

Inverse falloff.

_animTime

Float _animTime

Animation to to use for the falloff, this includes the effect of the animation speed.

_splineData

maxon::GenericDataRef _splineData

Internal spline-related data set up by InitFalloff.

_userData

maxon::GenericDataRef _userData

User data set up by InitFalloff.