FBApplyManagerRule Class Reference

Search for all occurrences

---

Detailed Description

ApplyManagerRules are used to define custom rules for manipulating custom objects.

It controls the relationship between the custom type objects and MB Core objects. For example, you can use it to allow the connection between your custom ragdoll physical property and the MB core character type object. And thus you can drag the ragdoll property from the asset browser or from scene navigator and attach it to a character.

Warning:

You shouldn't override the system default rule. All the function should return false if won't handle the call back.

Definition at line 113 of file fbapplymanagerrule.h.

#include <fbapplymanagerrule.h>

Inheritance diagram for FBApplyManagerRule:

List of all members.

Public Member Functions
	FBApplyManagerRule (HIObject pObject=NULL)
	Constructor.
virtual bool	IsValidSrc (HFBComponent)
	Return true if pSrc is the type of custom object which this rule to be defined for.
virtual bool	IsValidConnection (HFBComponent pSrc, HFBComponent &pDst, bool &pAllowMultiple)
	Return true if pDst is the type of custom or MB object which your custom object pSrc will be applied on.

---

Constructor & Destructor Documentation

FBApplyManagerRule

(

HIObject

pObject = NULL

)

Constructor.

Parameters:

pObject

For internal use only (default is NULL).

---

Member Function Documentation

virtual bool IsValidSrc

(

HFBComponent

)

[inline, virtual]

Search for all occurrences

Return true if pSrc is the type of custom object which this rule to be defined for.

Warning:

you should only return true if pSrc is the type of custom object you defined.

Definition at line 128 of file fbapplymanagerrule.h.

{ return false; }

virtual bool IsValidConnection	(	HFBComponent	pSrc,
		HFBComponent &	pDst,
		bool &	pAllowMultiple
	)		[inline, virtual]

Search for all occurrences

Return true if pDst is the type of custom or MB object which your custom object pSrc will be applied on.

it's possible to return proper destination and return it by pDst. For example, pSrc is RagDoll Property, pDst is a one of IK/FK bone, then you can find associated Character and replace.

Parameters:

pSrc	the custom type of object you drag it to attach another object.

Return values:

pDst	one of the selected destinations, it could be modified and return proper destination.
pAllowMultiple	return true if allow multiple objects of same type as pSrc to be connected to pDst.

Returns:

return true if connection between pSrc and pDst is allowed.

Definition at line 141 of file fbapplymanagerrule.h.

{ return false; }   

---

The documentation for this class was generated from the following file:

• fbsdk/fbapplymanagerrule.h