OpenCutList

https://docs.opencutlist.org
Admin
OpenCutList is a SketchUp extension that generates parts lists, cutting diagrams, printable labels,...
Tokens:36,615
Snippets:416
Trust Score:5.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### Material.any?

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns true if a material is applied.

```APIDOC
## Material.any?

### Description
Returns `true` if a material is applied.

### Method
Function

### Returns
- (Boolean) `true` if a material is applied.
```

--------------------------------

### Material.empty?

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns true if material is "no material".

```APIDOC
## Material.empty?

### Description
Returns `true` if material is "no material".

### Method
Function

### Returns
- (Boolean) `true` if material is "no material".
```

--------------------------------

### ComponentInstance.local_x

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns the x coordinate relative to parent origin (Length).

```APIDOC
## ComponentInstance.local_x

### Description
Returns the x coordinate relative to parent origin (Length).

### Method
Function

### Returns
- (Length) The x coordinate relative to parent origin.
```

--------------------------------

### ComponentInstance.world_x

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns the x coordinate relative to world origin (Length).

```APIDOC
## ComponentInstance.world_x

### Description
Returns the x coordinate relative to world origin (Length).

### Method
Function

### Returns
- (Length) The x coordinate relative to world origin.
```

--------------------------------

### Batch Properties

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Properties available for Batch objects.

```APIDOC
## Batch Properties

### Description
Properties available for Batch objects.

### Properties
- `position` (Integer) - The position.
- `count` (Integer) - The count.
```

--------------------------------

### Volume.to_m3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in m3.

```APIDOC
## Volume.to_m3

### Description
Returns volume as float value in m3.

### Method
Function

### Returns
- (Float) Volume in m3.
```

--------------------------------

### Material Properties

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Properties available for Material objects.

```APIDOC
## Material Properties

### Description
Properties available for Material objects.

### Properties
- `name` (String) - The name of the material.
- `color` (Color) - The color of the material.
- `type` (MaterialType) - The type of the material.
- `description` (String) - The description of the material.
- `url` (String) - The url of the material.
- `std_dimension` (String) - The standard dimension of the material.
- `std_thickness` (Length) - The standard thickness of the material.
- `std_width` (Length) - The width of the material.
```

--------------------------------

### Veneer Properties

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Properties available for Veneer objects.

```APIDOC
## Veneer Properties

### Description
Properties available for Veneer objects.

### Properties
- `material_name` (String) - Alias to `name`.
- `material_color` (Color) - Alias to `color`.
```

--------------------------------

### Volume.to_km3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in km3.

```APIDOC
## Volume.to_km3

### Description
Returns volume as float value in km3.

### Method
Function

### Returns
- (Float) Volume in km3.
```

--------------------------------

### Volume.to_fbm

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in FBM.

```APIDOC
## Volume.to_fbm

### Description
Returns volume as float value in FBM.

### Method
Function

### Returns
- (Float) Volume in FBM.
```

--------------------------------

### ComponentInstance.local_z

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns the z coordinate relative to parent origin (Length).

```APIDOC
## ComponentInstance.local_z

### Description
Returns the z coordinate relative to parent origin (Length).

### Method
Function

### Returns
- (Length) The z coordinate relative to parent origin.
```

--------------------------------

### Volume.to_mm3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in mm3.

```APIDOC
## Volume.to_mm3

### Description
Returns volume as float value in mm3.

### Method
Function

### Returns
- (Float) Volume in mm3.
```

--------------------------------

### Volume.to_feet3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in feet3.

```APIDOC
## Volume.to_feet3

### Description
Returns volume as float value in feet3.

### Method
Function

### Returns
- (Float) Volume in feet3.
```

--------------------------------

### Volume.to_cm3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in cm3.

```APIDOC
## Volume.to_cm3

### Description
Returns volume as float value in cm3.

### Method
Function

### Returns
- (Float) Volume in cm3.
```

--------------------------------

### Volume.to_yard3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in yard3.

```APIDOC
## Volume.to_yard3

### Description
Returns volume as float value in yard3.

### Method
Function

### Returns
- (Float) Volume in yard3.
```

--------------------------------

### Volume.to_inch3

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns volume as float value in inch3.

```APIDOC
## Volume.to_inch3

### Description
Returns volume as float value in inch3.

### Method
Function

### Returns
- (Float) Volume in inch3.
```

--------------------------------

### Area.to_m2

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns area as float value in m2.

```APIDOC
## Area.to_m2

### Description
Returns area as float value in m2.

### Method
Function

### Returns
- (Float) Area in m2.
```

--------------------------------

### ComponentInstance.world_z

Source: https://docs.opencutlist.org/features/parts/formulas/data-types

Returns the z coordinate relative to world origin (Length).

```APIDOC
## ComponentInstance.world_z

### Description
Returns the z coordinate relative to world origin (Length).

### Method
Function

### Returns
- (Length) The z coordinate relative to world origin.
```
Tokens:
Raw