c4d.plugins.FalloffData

New in version R13.029.

This class is the base falloff class. Falloffs will appear in any falloff descriptions (unless the flag PLUGIN_HIDE is used during registration), and extend the functionality of tools such as effectors (or anything that uses the falloffs). Use RegisterFalloffPlugin() to register the plugin.

Definition

class c4d.plugins.FalloffData

• FalloffData.Init()
• FalloffData.InitFalloff()
• FalloffData.FreeFalloff()

• FalloffData.Sample()

• FalloffData.CheckDirty()
• FalloffData.GetDVisible()

• FalloffData.GetHandleCount()
• FalloffData.GetHandle()
• FalloffData.SetHandle()

• FalloffData.Draw()
• FalloffData.Message()

Inheritance

• c4d.plugins.BaseData
  • c4d.plugins.FalloffData

Members

FalloffData.Init(falldata, bc)

Called when the falloff is first created.

Parameters:

• falldata (FalloffDataData) – Falloff data information.
• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.

Return type:

bool

Returns:

True if successful, otherwise False.

FalloffData.InitFalloff(bc, falldata)

Called just before sampling. Allows you to set up any necessary data in falldata or bc.

Parameters:

• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.
• falldata (FalloffDataData) – Falloff data information.

Return type:

bool

Returns:

True if successful, otherwise False.

FalloffData.Sample(p, data)

Called to sampe any point.

Parameters:

• p (Vector) – The position of the point to sample in falloff space.
• data (FalloffDataData) – Falloff data information.

Return type:

float

Returns:

The falloff value.

FalloffData.FreeFalloff(falldata)

Called when the falloff object is freed.

Parameters: falldata (FalloffDataData) – Falloff data information.

FalloffData.CheckDirty(bc)

Parameters: bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer. Return type: bool Returns: Dirty state.

FalloffData.GetDVisible(id, bc, desc_bc)

Called to change the visibility of any element in the description; just return True or False for the id.

Parameters:

• id (DescID) – The ID being evaluated.
• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.
• desc_bc (BaseContainer) – The description element’s container.

Return type:

bool

Returns:

Visibility of id.

FalloffData.GetHandleCount(bc, data)

For allowing you to add handles.

Parameters:

• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.
• falldata (FalloffDataData) – Falloff data information.

Return type:

long

Returns:

The number of handles.

FalloffData.GetHandle(bc, i, info, data)

For allowing you to add handles.

Parameters:

• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.
• i (long) – The handle index.
• info (HandleInfo) – The handle info.
• data (FalloffDataData) – Falloff data information.

Return type:

Vector

Returns:

The current local position of the handle with index i.

FalloffData.SetHandle(bc, i, p, data)

For allowing you to add handles. Called when the user has moved handle i to position p. Constrain the movement and update your internal data from it!

Parameters:

• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.
• i (long) – The handle index.
• p (Vector) – The new position for handle i.
• data (FalloffDataData) – Falloff data information.

FalloffData.Draw(data, drawpass, bd, bh)

For allowing you to draw the falloff in the viewport. You should use these predefined color constants:

FALLOFFCAGE	Default cage color
FALLOFFFALLOFF	Default falloff color

Parameters:

• data (FalloffDataData) – Falloff data information.
• drawpass (long) –

  One of the following:

  DRAWPASS_OBJECT	Object pass
  DRAWPASS_BOX	Box pass
  DRAWPASS_HANDLES	Handle pass
  DRAWPASS_HIGHLIGHTS	Highlights pass
  DRAWPASS_XRAY	X-ray pass

• bd (BaseDraw) – The editor’s view.
• bh (BaseDrawHelp) – The BaseDrawHelp editor’s view.

Return type:

bool

Returns:

Success of drawing into the editor view.

FalloffData.Message(type, bc, m_data)

Parameters:

• type (long) –

  The message ID, one of the following:

  MSG_POINTS_CHANGED	The points have changed. The corresponding data is VariableChanged.
  MSG_POLYGONS_CHANGED	The polygons have changed. The corresponding data is VariableChanged.
  MSG_UPDATE	Must be sent if the bounding box has to be recalculated. (Otherwise you can use MSG_CHANGE.)
  MSG_SMALLUPDATE	Part of the object has changed that needs no cache rebuilding. Note: This message should be used very carefully, it is there for (small) performance enhancements, for example if a polygon selection is changed then the caches needn’t be rebuilt, so MSG_SMALLUPDATE can be sent.
  MSG_CHANGE	Must be sent if any object data (except for the matrix) has been changed.
  MSG_BASECONTAINER	Message with a container, for example from a C.O.F.F.E.E. plugin. The corresponding data is BaseContainer.
  MSG_SEGMENTS_CHANGED	The segments have changed. The corresponding data is VariableChanged.
  MSG_FILTER	A message filter that lets you block C4DAtom.MultiMessage() calls. The corresponding data is MessageFilter. Return True to let the message pass and False to block it!
  MSG_TRANSFERGOALS	Internal message!
  MSG_DESCRIPTION_INITUNDO	Allows elements to create undo actions for the following parameter changes in the attributes manager. This is already automatically handled for keys, tags, objects etc. The corresponding data is DescriptionInitUndo.
  MSG_DESCRIPTION_CHECKUPDATE	Allows elements to determine the type of refresh after a parameter has been changed in the Active manager. This is already automatically handled for keys, tags, objects etc. The corresponding data is DescriptionCheckUpdate. Note: Currently this message is completely handled by all baseclasses. Most plugins won’t need to modify the message data. It’s more interesting to start some update action - e.g. deleting data that will be rebuilt with the next access.
  MSG_DESCRIPTION_COMMAND	Sent by for example BUTTON (description element). The corresponding data is DescriptionCommand.
  MSG_DESCRIPTION_POPUP	Allows popup menu handling in the Attribute Manager. The corresponding data is DescriptionPopup.
  MSG_DESCRIPTION_POSTSETPARAMETER	After a SetParameter() call to an atom element this message is sent to the object. The corresponding data is DescriptionPostSetValue.
  MSG_DESCRIPTION_VALIDATE	Allows you to update dependencies or to check for invalid values after a parameter has been changed (For example: the light’s inner radius always must be smaller than the light’s outer radius - so this routine checks for it and corrects it). The corresponding data is DescriptionValidate.
  MSG_EDIT	Allows elements to do some action if the user edits the element (doubleclick e.g. in object manager).
  MSG_MENUPREPARE	Allows tags, objects, shaders etc. to do some setup work when called from the menu. The corresponding data is the current BaseDocument.
  MSG_RETRIEVEPRIVATEDATA	A generic private message to retrieve data from an object. Specific for every type of object so no public documentation available. The corresponding data is RetrievePrivateData.
  MSG_DESCRIPTION_REMOVE_ENTRY	Tells the node to remove a description entry. The corresponding data is DescriptionCommand.
  MSG_DESCRIPTION_EDIT_ENTRY	Tells the node to edit a description entry. The corresponding data is DescriptionCommand.
  MSG_DESCRIPTION_CHECKDRAGANDDROP	Asks the node if a drag and drop onto for example a LINK (description element) field should be accepted. The corresponding data is DescriptionCheckDragAndDrop.
  MSG_DESCRIPTION_GETBITMAP	Queries the object for updated bitmaps for BitmapButtonCustomGui elements in the description. (E.g. the lens flare preview.) The corresponding data is DescriptionGetBitmap.
  MSG_DESCRIPTION_GETOBJECTS	Private.
  MSG_DESCRIPTION_USERINTERACTION_END	End of user interaction.
  MSG_DESCRIPTION_GETINLINEOBJECT	Sent by the Attribute Manager to the object. The object can check for a description ID and return the linked objects in the atom array. The corresponding data is DescriptionInlineObjectMsg.
  MSG_MOVE_FINISHED	Sent after a handle or the object has been moved.
  MSG_MOVE_START	Sent before a handle or the object has been moved.
  MSG_EDITABLE_END	Private.
  MSG_GETCUSTOMICON	Every atom can return a custom icon with this message. The corresponding data is GetCustomIconData.
  MSG_MATERIALDRAGANDDROP	Received by a material upon dropping an instance of the material onto an object. The material can choose to create a tag of its own, or trigger other actions, instead of letting CINEMA 4D create a normal material assignment. The corresponding data is MaterialDragAndDrop. For example Sketch and Toon creates its own type of tag and returns it in result. CINEMA 4D creates the undo for it and activates it. Inserting the tag is done by the material.
  MSG_DRAGANDDROP	Received when something is dropped on it. The corresponding data is DragAndDrop.
  MSG_INITIALCHANNEL	See HandleInitialChannel().
  MSG_DOCUMENTINFO	Sent as broadcast message to the document when it its loaded, saved etc. The corresponding data is DocumentInfoData. (See the type member for more information about when the message is sent.)
  MSG_GETSELECTION	Private.
  MSG_MULTI_RENDERNOTIFICATION	A document and all of its elements receive this message before a render starts. The corresponding data is RenderNotificationData.
  MSG_MULTI_MARKMATERIALS	When data is None this is sent to plugin nodes to let them mark the materials that they use. Otherwise the message is sent to let you translate you material links, for example when a material is replaced, and then the corresponding structure is MarkMaterials. (An example for both cases is included on the MarkMaterials page.)
  MSG_MULTI_DOCUMENTCLONED	The document has been cloned.
  MSG_MULTI_DOCUMENTIMPORTED	After a C4D document has been loaded this message is sent to the document (and all children structures). The corresponding data is DocumentImported.
  MSG_MULTI_SETNEWMARKERS	Private.
  MSG_MULTI_CLEARSUGGESTEDFOLDER	Objects have to remove absolute paths (only if they support MSG_GETALLASSETS). Both are important for SaveProject to work and to collect all items.
  MSG_TRANSLATE_POINTS	Sent by the modeling core to let tags etc. update after point changes. The corresponding data is TranslationMaps.
  MSG_TRANSLATE_POLYGONS	Sent by the modeling core to let tags etc. update after polygon changes. The corresponding data is TranslationMaps.
  MSG_TRANSLATE_NGONS	Sent by the modeling core to let tags etc. update after N-gon changes. The corresponding data is TranslationMaps.
  MSG_TRANSLATE_SEGMENTS	Sent by the modeling core to let tags etc. update after segment changes. The corresponding data is TranslationMaps.
  MSG_PRETRANSLATE_POINTS	Sent before MSG_TRANSLATE_POINTS, before the changes are actually carried out. The corresponding data is TranslationMaps.
  MSG_PRETRANSLATE_POLYGONS	Sent before MSG_TRANSLATE_POLYGONS, before the changes are actually carried out. The corresponding data is TranslationMaps.
  MSG_PRETRANSLATE_NGONS	Sent before MSG_TRANSLATE_NGONS, before the changes are actually carried out. The corresponding data is TranslationMaps.
  MSG_PRETRANSLATE_SEGMENTS	Sent before MSG_TRANSLATE_SEGMENTS, before the changes are actually carried out. The corresponding data is TranslationMaps.
  MSG_UPDATE_NGONS	Should be sent if points are changed and any N-gons need updating. CINEMA 4D will then update the N-gons, if the user has this option enabled.
  MSG_DOCUMENT_MODE_CHANGED	Sent to the active tool plugin during BaseDocument.SetMode().
  MSG_TOOL_RESTART	Private. (Handles the tool description apply behaviour after mouse clicks.)
  MSG_DEFORMMODECHANGED	Private.
  MSG_ANIMATE	Sent to objects after they have been animated.
  MSG_CALCMEMUSAGE	Private.
  MSG_SCALEDOCUMENT	Tells the document that another document with different scale has been merged. The corresponding data is MessageScaleDocument.
  MSG_GET_INHERITANCECONTAINER	Private.
  MSG_SOFTTAG_UPDATE	Private.

• bc (BaseContainer) – Falloff’s basecontainer; normally this is the owning object’s basecontainer.
• m_data (any) – The message data.

Return type:

bool

Returns:

Depends on the message type.