Key control. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBKeyControl:

[legend]

Public Member Functions
	FBKeyControl ()
	Constructor.

	MoveKeys (FBTimeSpan pTimeSpan, FBModel pPivot, FBVector3d pT, FBVector3d pR, FBVector3d pS, FBTime pTime, FBModelList pModelList=None)
	Move animation keys in space, with respect to a pivot object.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
bool	AutoKey
	Read Write Property: Enable/Disable Auto Key feature (key when moving 3D objects).

FBNewKeyInterpolationType	NewKeyInterpolationType
	Read Write Property: Current key interpolation type that will be used for new keys.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed Description

Key control.

Interface to use the key controls tool.

See sample: MirrorPoseOverTime.py.

Constructor & Destructor Documentation

◆ FBKeyControl()

FBKeyControl ( )

Constructor.

Member Function Documentation

◆ MoveKeys()

MoveKeys	(	FBTimeSpan	pTimeSpan,
		FBModel	pPivot,
		FBVector3d	pT,
		FBVector3d	pR,
		FBVector3d	pS,
		FBTime	pTime,
		FBModelList	pModelList = `None`
	)

Move animation keys in space, with respect to a pivot object.

Equivalent to using the "Move Keys" button in the Key Controls panel. Only keys that are part of the current animation layer will get affected.

Parameters

pTimeSpan	The time span in which the animation keys will be modified
pPivot	The pivot object to use as a reference. The pivot needs to be part of pModelList (or the current keying group) otherwise the move keys operation will abort
pT	The global translation to apply to the pivot
pR	The global Euler rotation to apply to the pivot (deg)
pS	The global scaling factors to apply to the pivot
pTime	The time at which the transformation values are applied to the pivot object
pModelList	List of models for which the animation will be modified. Optional parameter. If not supplied, the models in the current keying group will be used

Member Data Documentation

◆ AutoKey

bool AutoKey

Read Write Property: Enable/Disable Auto Key feature (key when moving 3D objects).

◆ NewKeyInterpolationType

FBNewKeyInterpolationType NewKeyInterpolationType

Read Write Property: Current key interpolation type that will be used for new keys.

Public Member Functions

Public Attributes