sdf-operations

Methods

(static) opIntersect(…sdfData)

SDF intersection operation. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opIntersectChamfer(options, …sdfData)

SDF intersection operation with a chamfer effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opIntersectColumns(options, …sdfData)

SDF intersection operation with a column stairs effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
steps integer Number of column steps
colorBlendAmount number Amount of color blend at geometry intersections
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opIntersectRound(options, …sdfData)

SDF intersection operation with a round blend. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opIntersectStairs(options, …sdfData)

SDF intersection operation with a stairs effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
steps integer Number of stair steps
colorBlendAmount number Amount of color blend at geometry intersections
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opSubtract(sdfData, …sdfData)

SDF subtraction operation. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
sdfData sdfGeometry | sdfOperation The term to subtract from. An sdf geometry, or sdf operation consisting of multiple geometries.
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry, or sdf operation consisting of multiple geometries, to subtract from the first term.
Source:

(static) opSubtractChamfer(options, sdfData, …sdfData)

SDF subtraction operation with a chamfer effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
sdfData sdfGeometry | sdfOperation The term to subtract from. An sdf geometry, or sdf operation consisting of multiple geometries.
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry, or sdf operation consisting of multiple geometries, to subtract from the first term.
Source:

(static) opSubtractColumns(options, sdfData, …sdfData)

SDF subtraction operation with a columns stairs effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
steps integer Number of columns
sdfData sdfGeometry | sdfOperation The term to subtract from. An sdf geometry, or sdf operation consisting of multiple geometries.
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry, or sdf operation consisting of multiple geometries, to subtract from the first term.
Source:

(static) opSubtractRound(options, sdfData, …sdfData)

SDF subtraction operation with a round blend. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
sdfData sdfGeometry | sdfOperation The term to subtract from. An sdf geometry, or sdf operation consisting of multiple geometries.
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry, or sdf operation consisting of multiple geometries, to subtract from the first term.
Source:

(static) opSubtractStairs(options, sdfData, …sdfData)

SDF subtraction operation with a stairs effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
steps integer Number of stair steps
sdfData sdfGeometry | sdfOperation The term to subtract from. An sdf geometry, or sdf operation consisting of multiple geometries.
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry, or sdf operation consisting of multiple geometries, to subtract from the first term.
Source:

(static) opUnion(…sdfData)

SDF union operation. Needs to be wrapped by the sdf() function call. See example with sdf() here. NOTE! You shouldn't use this for performance reasons. If you need a regular union you should just create another geometry and wrap it in a new sdf() call. The engine will handle the union for you and each geometry will have its own bounding box for BVH construction (=speedier!).
Parameters:
Name Type Attributes Description
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opUnionChamfer(options, …sdfData)

SDF union operation with a chamfer effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
colorBlendAmount number Amount of color blend at geometry intersections
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opUnionColumns(options, …sdfData)

SDF union operation with columns effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
steps integer Number of colymn steps
colorBlendAmount number Amount of color blend at geometry intersections
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opUnionRound(options, …sdfData)

SDF union operation with a round blend. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
colorBlendAmount number Amount of color blend at geometry intersections
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source:

(static) opUnionStairs(options, …sdfData)

SDF union operation with a stairs effect. Needs to be wrapped by the sdf() function call. See example with sdf() here.
Parameters:
Name Type Attributes Description
options object Operator options
Properties
Name Type Description
radius number Thickness of the blending
steps integer Number of stair steps
colorBlendAmount number Amount of color blend at geometry intersections
sdfData sdfGeometry | sdfOperation <repeatable>
An sdf geometry or sdf operation consisting of multiple geometries.
Source: