#include <c4d_falloffdata.h>

Inheritance diagram for FalloffData:

Detailed Description

A data class for creating falloff plugins.
Falloffs appear in any falloff description (unless the flag PLUGINFLAG_HIDE is set during registration) and extend the functionality of effectors and anything that uses falloffs.
Use RegisterFalloffPlugin() to register a falloff plugin.

Public Member Functions
virtual Bool	CheckDirty (BaseContainer *bc)

virtual Bool	GetDVisible (DescID &id, BaseContainer bc, BaseContainer desc_bc)

virtual DRAWRESULT	Draw (const FalloffDataData &data, DRAWPASS drawpass, BaseDraw bd, BaseDrawHelp bh)

virtual Bool	Message (Int32 type, BaseContainer bc, void m_data)

Public Member Functions inherited from BaseData
	BaseData ()

virtual	~BaseData (void)

void	Destructor (void)

Init/Sample/Free
virtual Bool	Init (FalloffDataData &falldata, BaseContainer *bc)

virtual Bool	InitFalloff (BaseContainer *bc, FalloffDataData &falldata)

virtual void	Sample (const Vector &p, const FalloffDataData &data, Float *res)

virtual void	FreeFalloff (FalloffDataData &falldata)

Handle
virtual Int32	GetHandleCount (BaseContainer *bc, const FalloffDataData &data)

virtual void	GetHandle (BaseContainer *bc, Int32 i, HandleInfo &info, const FalloffDataData &data)

virtual void	SetHandle (BaseContainer *bc, Int32 i, Vector p, const FalloffDataData &data)

Member Function Documentation

◆ Init()

virtual Bool Init	(	FalloffDataData &	falldata,
		BaseContainer *	bc
	)

virtual

Called to initialize the falloff when it is first created.

Parameters

[in,out]	falldata	The falloff's data.
[in,out]	bc	The falloff's container; normally this is the owning object's container.

Returns: true if successful, otherwise false.

◆ InitFalloff()

virtual Bool InitFalloff	(	BaseContainer *	bc,
		FalloffDataData &	falldata
	)

virtual

Called to initialize the falloff just before sampling. Allows to setup any necessary data in falldata or bc.

Parameters

[in,out]	bc	The falloff's data.
[in,out]	falldata	The falloff's container; normally this is the container of the object owning the falloff.

Returns: true if successful, otherwise false.

◆ Sample()

virtual void Sample	(	const Vector &	p,
		const FalloffDataData &	data,
		Float *	res
	)

virtual

Called to sample any point. Assign res to return the sampled value.

Parameters

[in]	p	The position of the point to sample in falloff space.
[in]	data	The falloff's data.
[out]	res	Set to the sampled value.

◆ FreeFalloff()

virtual void FreeFalloff ( FalloffDataData & falldata )

virtual

Called to free the falloff.

Parameters

[in] falldata The falloff's data.

◆ CheckDirty()

virtual Bool CheckDirty ( BaseContainer * bc )

virtual

Called to check for a change in the falloff.

Parameters

[in] bc The falloff's container; normally this is the container of the object owning the falloff.

Returns: true if the falloff is dirty, otherwise false.

◆ GetDVisible()

virtual Bool GetDVisible	(	DescID &	id,
		BaseContainer *	bc,
		BaseContainer *	desc_bc
	)

virtual

Called to change the visibility of any element in the falloff description. Just return true or false for the id (like NodeData::GetDEnabling).

Parameters

[in]	id	The description ID.
[in,out]	bc	The falloff's container; normally this is the container of the object owning the falloff.
[in,out]	desc_bc	The description element's container.

Returns: true if the description element should be visible, otherwise false.

◆ GetHandleCount()

virtual Int32 GetHandleCount	(	BaseContainer *	bc,
		const FalloffDataData &	data
	)

virtual

Called to get the number of handles for the falloff.
Same as ObjectData::GetHandleCount with additional FalloffDataData.

Parameters

[in,out]	bc	The falloff's container; normally this is the container of the object owning the falloff.
[in,out]	data	The falloff's data.

Returns: The handle count.

◆ GetHandle()

virtual void GetHandle	(	BaseContainer *	bc,
		Int32	i,
		HandleInfo &	info,
		const FalloffDataData &	data
	)

virtual

Called to get a handle for the falloff.
Same as ObjectData::GetHandle with additional FalloffDataData.

Parameters

[in,out]	bc	The falloff's container; normally this is the container of the object owning the falloff.
[in]	i	The handle index.
[out]	info	Filled with the information for handle i.
[in,out]	data	The falloff's data.

◆ SetHandle()

virtual void SetHandle	(	BaseContainer *	bc,
		Int32	i,
		Vector	p,
		const FalloffDataData &	data
	)

virtual

Called to set a handle for the falloff.
Same as ObjectData::SetHandle with additional FalloffDataData.
Called when the user has moved handle i to position p. Constrain the movement and update the internal data.

Parameters

[in,out]	bc	The falloff's container; normally this is the container of the object owning the falloff.
[in]	i	The handle index.
[in]	p	The new position for handle i.
[in,out]	data	The falloff's data.

◆ Draw()

virtual DRAWRESULT Draw	(	const FalloffDataData &	data,
		DRAWPASS	drawpass,
		BaseDraw *	bd,
		BaseDrawHelp *	bh
	)

virtual

Called to draw the falloff in the viewport.
Same as ObjectData::Draw with additional FalloffDataData.
These predefined color constants should be used: FALLOFFCOLORS

Parameters

[in,out]	data	The falloff's data.
[in]	drawpass	The draw pass: DRAWPASS
[in]	bd	The editor's view. The caller owns the pointed base draw.
[in]	bh	The editor's view help. The caller owns the pointed base draw help.

Returns: The result of drawing into the editor view: DRAWRESULT

◆ Message()

virtual Bool Message	(	Int32	type,
		BaseContainer *	bc,
		void *	m_data
	)

virtual

Called to process messages sent to the falloff.

Parameters

[in]	type	The message type: MSG
[in,out]	bc	The falloff's container; normally this is the container of the object owning the falloff.
[in,out]	m_data	The message data. The sender owns the pointed data.

Returns: true if successful, otherwise false.

Detailed Description

Public Member Functions

Init/Sample/Free

Handle

Member Function Documentation

◆ Init()

◆ InitFalloff()

◆ Sample()

◆ FreeFalloff()

◆ CheckDirty()

◆ GetDVisible()

◆ GetHandleCount()

◆ GetHandle()

◆ SetHandle()

◆ Draw()

◆ Message()