ElementPlanarClipMaskArgs Interface

Arguments supplied to PlanarClipMaskSettings.create to create a mask of PlanarClipMaskMode.IncludeElements or PlanarClipMaskMode.ExcludeElements.

Extends

Properties

Name Type Description
elementIds Iterable<string> The elements used by the mask.  
exclude undefined | boolean If true, creates a mask of PlanarClipMaskMode.ExcludeElements; otherwise, PlanarClipMaskMode.IncludeElements.  
modelIds undefined | Iterable<string> See PlanarClipMaskSettings.modelIds.  

Inherited properties

Name Type Inherited from Description
invert undefined | boolean BasicPlanarClipMaskArgs See PlanarClipMaskSettings.invert.
transparency undefined | number BasicPlanarClipMaskArgs See PlanarClipMaskSettings.transparency.

Defined in

Last Updated: 30 November, 2023