
<div class="tsd-page-title">
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
<li><a href="" aria-current="page">RibbonOptions</a></li></ul>
<h1>Interface RibbonOptions</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>Options for <code>createRibbonData</code>: a set of parallel paths joined into a strip.</p>
</div></section>
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RibbonOptions</span> <span class="tsd-signature-symbol">{</span><br>    <a class="tsd-kind-property" href="#closearray">closeArray</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br>    <a class="tsd-kind-property" href="#closepath">closePath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br>    <a class="tsd-kind-property" href="#offset">offset</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br>    <a class="tsd-kind-property" href="#patharray">pathArray</a><span class="tsd-signature-symbol">:</span> <a href="Vec3.html" class="tsd-signature-type tsd-kind-interface">Vec3</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/a2601bc413c969c55610b70dc73bb8c892c7e8a7/packages/babylon-lite/src/mesh/create-ribbon.ts#L26">packages/babylon-lite/src/mesh/create-ribbon.ts:26</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-index-list"><a href="#closearray" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close<wbr>Array?</span></a>
<a href="#closepath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close<wbr>Path?</span></a>
<a href="#offset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>offset?</span></a>
<a href="#patharray" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path<wbr>Array</span></a>
</div></section></div></details></section></section>
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
<section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="closearray"><code class="tsd-tag">Optional</code><span>close<wbr>Array</span><a href="#closearray" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">closeArray</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/a2601bc413c969c55610b70dc73bb8c892c7e8a7/packages/babylon-lite/src/mesh/create-ribbon.ts#L28">packages/babylon-lite/src/mesh/create-ribbon.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="closepath"><code class="tsd-tag">Optional</code><span>close<wbr>Path</span><a href="#closepath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">closePath</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/a2601bc413c969c55610b70dc73bb8c892c7e8a7/packages/babylon-lite/src/mesh/create-ribbon.ts#L29">packages/babylon-lite/src/mesh/create-ribbon.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="offset"><code class="tsd-tag">Optional</code><span>offset</span><a href="#offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/a2601bc413c969c55610b70dc73bb8c892c7e8a7/packages/babylon-lite/src/mesh/create-ribbon.ts#L30">packages/babylon-lite/src/mesh/create-ribbon.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="patharray"><span>path<wbr>Array</span><a href="#patharray" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">pathArray</span><span class="tsd-signature-symbol">:</span> <a href="Vec3.html" class="tsd-signature-type tsd-kind-interface">Vec3</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon-Lite/blob/a2601bc413c969c55610b70dc73bb8c892c7e8a7/packages/babylon-lite/src/mesh/create-ribbon.ts#L27">packages/babylon-lite/src/mesh/create-ribbon.ts:27</a></li></ul></aside></section></section></details>

Welcome

Getting Started

Feature Comparison

Porting Guide

Playground

Headless Null Engine

Overview

Scene

Camera

Lights

Loaders

Background Skybox

PBR Material

Animation

Standard Material

Texture 2D

Mesh Generators

Scene Hierarchy Parenting

Thin Instances

Skeleton

Morph Targets

Vertex Animation Texture

Shadow Generator

Cascaded Shadow

Picking

Loader HDR

Loader Babylon

Core Math

Engine

Shader Composition

Shader Material

Grid Material

Material Plugin

Render Pipeline

Frame Graph

Post Process

Effect Renderer

Geometry Renderer

Sprites

Text

Geospatial Camera

Large World Rendering

High Precision Matrix

Resource Pool

Bundle Size Tooling

Animation Parity Testing

Material Stencil

Audio Engine

Node Particle

Physics

Webxr

Mesh Geometry Update

Storage Buffer

Mesh Geometry Access

Error Handling

Line System

Device Lost Recovery

Alpha To Coverage

Flow Graph

Screen Space Effects

Async Shader Pipeline Compilation

Compute

Texture Array

World Screen Projection

Gaussian Splat Streaming

Mesh Blending

Render Shader

Texture Region

Texture Render Target

Engine Gpu Events

Demo Antigravity Racer

Demo Ocean

Demo Playroom

Loader Usd

Node Block Selection

Architecture

Bundle Size Results

Interface RibbonOptions

Index

Properties

Properties

`Optional`closeArray

`Optional`closePath

`Optional`offset

pathArray

Interface RibbonOptions

Index

Properties

Properties

OptionalcloseArray

OptionalclosePath

Optionaloffset

pathArray

`Optional`closeArray

`Optional`closePath

`Optional`offset