= Attribute Gradient =



#type: node
#context: sop
#internal: attribGradient
#icon: opdef:.?icon64.svg



"""Computes the gradient of a scalar attribute using connectivity or proximity."""



@parameters

Group:
    #id: group
    Subset of geometry to use.

Group Type:
    #id: grouptype
    The type of entities in the group.

Attribute:
    #id: attribute
    Name of the input attribute.

New Attribute:
    #id: new
    Name of the new attribute that will store the gradient.

Method:
    #id: method
    The method used to compute the gradient.
    
    Connectivity:
        Uses edge connectivity to compute the gradient.
        
    Point Cloud:
        Uses point proximity to compute the gradient.
    
Neighbouring:
    #id: neighbouring
    The type of neighbouring to use.
    
    By Edges:
        Uses the edge neighbours of each point when gathering their point neighbours.
        
    By Primitives:
        Uses the primitive neighbours of each point when gathering their point neighbours.
        
Depth:
    #id: depth
    Number of edges/primitives away from the points.
    
Radius:
    #id: r
    The radius of the search.

Max Points:
    #id: maxpts
    The maximum number of points queried within the search radius.

Use Radius Attribute:
    #id: useradius
    Uses a per-point radius attribute.

Radius Attribute:
    #id: radius
    Per-point radius attribute that expands the search radius.

Radius Scale:
    #id: rscale
    Multiplier for the radius attribute.
    
Invert:
    #id: invert
    Negates the direction of the gradient vector.

Show Guide:
    #id: guide
    Shows the gradient vectors in the viewport.
    
Guide Scale:
    #id: guidescale
    The scale of the guide geometry.