Skip to content

ConstraintSurface

ConstraintSurface#

(Surface)

No corresponding User page.

Description#

Keeps the object located and optionally oriented onto the specified geometry.

Public Attributes#

Type Name Visual Hint Description
action pick_target VISUAL_HINT_DEFAULT Invoke Clone Stamp Tool to specify the target.
reference (SceneObject) target VISUAL_HINT_DEFAULT Set the geometry used as target.
action set_offset VISUAL_HINT_DEFAULT Invoke Translate Tool to specify the constraint Offset.
double[3] offset VISUAL_HINT_DISTANCE Specify the object's offset in constrained space.
bool orient VISUAL_HINT_DEFAULT Enable orientation constraint: align Up vector onto target normal.
action set_orientation VISUAL_HINT_DEFAULT Invoke Rotate Tool to specify the Up vector and Roll.
double[3] up_vector VISUAL_HINT_DEFAULT Specify the object's vector to orient.
double roll VISUAL_HINT_ANGLE Specify the object's rotation around target normal.

Inherited Public Attributes#

Type Name Visual Hint Description
double weight VISUAL_HINT_PERCENTAGE Set the weight of the constraint. With a value of 50% the item will be half way constraint position.

CID#

class "ConstraintSurface" "Constraint" {
    #version 0.9
    icon "../icons/object_icons/constraint_target.iconrc"
    doc "Keeps the object located and optionally oriented onto the specified geometry."
    attribute_group "target_definition" {
        action "pick_target" {
            doc "Invoke Clone Stamp Tool to specify the target."
            value <empty>
        }
        reference "target" {
            doc "Set the geometry used as target."
            filter "SceneObject"
            input "motion" "geometry"
            output "motion" "geometry"
            value ""
        }
        double[3] "target_UVW" {
            hidden yes
            value 0.0 0.0 0.0
        }
        long "target_id" {
            hidden yes
            value -1
        }
        long "local_geometry_index" {
            hidden yes
            value 0
        }
        long[] "geometry_id_hierarchy" {
            doc "List of scene object id intersected by the raycast in regards of their parents."
            hidden yes
            value <empty>
        }
    }
    attribute_group "geometry" {
        action "set_offset" {
            doc "Invoke Translate Tool to specify the constraint Offset."
            value <empty>
        }
        distance[3] "offset" {
            doc "Specify the object\'s offset in constrained space."
            animatable yes
            value 0.0 0.0 0.0
        }
        bool "orient" {
            doc "Enable orientation constraint: align Up vector onto target normal."
            value yes
        }
        action "set_orientation" {
            doc "Invoke Rotate Tool to specify the Up vector and Roll."
            value <empty>
        }
        double[3] "up_vector" {
            doc "Specify the object\'s vector to orient."
            animatable yes
            value 0.0 1 0.0
        }
        angle "roll" {
            doc "Specify the object\'s rotation around target normal."
            animatable yes
            value 0.0
        }
    }
}