SgCone

A 3D cone-shaped mesh that can be placed and transformed in the scene. Useful for visual effects, markers, or representing spotlights or volumes. Can be customized with height, radius, and resolution parameters.

Inherits from

Usage

To use this class, add the following require at the top of your script:

local SgCone = require 'engine/sceneobjects/sgcone'

Reference

class SgCone
module:
create(options, parent)

Create a new cone object in the scenegraph.

Parameters:

  • options (table) – A table of options to fill the parameters

  • parent (SceneObject) – The parent scene object to add this to

Returns:

a promise which will resolve to the created object

Return type:

Promise

Usage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
-- Options can be omitted. This example shows the defaults,
-- only specify the ones you want different.
SgCone:create({
    active = true,
    name = "",
    transform = Transform.new(),
    layers = {0},
    tags = {},
    receiveShadow = false,
    castShadow = false,
    material = nil,
    radius = 1,
    height = 1,
    radialSegments = 8,
    heightSegments = 1,
    openEnded = false,
    thetaStart = 0,
    thetaLength = 360
})

Examples