ThreePipe
    Preparing search index...

    Class ObjectConstraintsPlugin

    Object Constraints Plugin

    Create sophisticated object relationships and behaviors using simple constraint-based animation system inspired by Blender's constraints.

    The ObjectConstraintsPlugin provides a powerful constraint system that allows objects to automatically follow, copy, or respond to other objects' transformations and properties. This enables complex animations and interactive behaviors without manual keyframe animation.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _dirty _viewer? _viewerListeners constructor dependencies enabled uiConfig? ConstraintTypes OldPluginType? PluginType

    Accessors

    dirty

    Methods

    _onViewerEvent _storeKey addConstraint disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove removeConstraint setDirty? toJSON

    Constructors

    Properties

    Protected_dirty

    _dirty: boolean = false

    Protected Optional_viewer

    _viewer?: ThreeViewer

    Protected_viewerListeners

    _viewerListeners: { preFrame: () => void } = ...
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    dependencies: never[] = []
    enabled: boolean = true
    uiConfig?: UiObjectConfig<any, string, any> = undefined
    ConstraintTypes: Record<
        keyof ConstraintPropsTypes,
        {
            defaultProps: ConstraintPropsType;
            setDirty?: (
                e: { args?: any[]; bubbleToParent: boolean; object: IObject3D } & Omit<
                    IObjectSetDirtyOptions,
                    "bubbleToParent",
                >,
                isTarget?: boolean,
            ) => boolean;
            update: (
                obj: IObject3D,
                target:
                    | undefined
                    | IObject3D<
                        IObject3DEventMap,
                        undefined
                        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                            | undefined
                            | IMaterial<IMaterialEventMap>
                            | IMaterial<IMaterialEventMap>[],
                    >,
                props: ConstraintPropsType,
                influence: number,
            ) => { change?: string; changed: boolean; end?: boolean };
        },
    > = basicObjectConstraints
    OldPluginType?: string
    PluginType: "ObjectConstraintsPlugin" = 'ObjectConstraintsPlugin'

    Accessors

    Methods

    Protected_onViewerEvent

    Protected_storeKey

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods