CsgTorus3D

A CSG Torus shape.

1.0.0

class CsgTorus3DReckfellSharpInherits CsgPrimitive3D

A CSG Torus shape.

This node allows you to create a torus for use with the CSG system. Note: CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a MeshInstance3D with a PrimitiveMesh. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

CsgTorus3DConstructor

# CsgTorus3D

C#
public CsgTorus3D();

Properties6

InnerRadiusProperty

# InnerRadius

C#
public float InnerRadius { get; set; }

The inner radius of the torus.

MaterialProperty

# Material

C#
public Material Material { get; set; }

The material used to render the torus.

OuterRadiusProperty

# OuterRadius

C#
public float OuterRadius { get; set; }

The outer radius of the torus.

RingSidesProperty

# RingSides

C#
public int RingSides { get; set; }

The number of edges each ring of the torus is constructed of.

SidesProperty

# Sides

C#
public int Sides { get; set; }

The number of slices the torus is constructed of.

SmoothFacesProperty

# SmoothFaces

C#
public bool SmoothFaces { get; set; }

If true the normals of the torus are set to give a smooth effect making the torus seem rounded. If false the torus will have a flat shaded look.

Methods12

GetInnerRadiusfloat

# GetInnerRadius

C#
public float GetInnerRadius();

Returns float

GetMaterialMaterial

# GetMaterial

C#
public Material GetMaterial();

Returns Material

GetOuterRadiusfloat

# GetOuterRadius

C#
public float GetOuterRadius();

Returns float

GetRingSidesint

# GetRingSides

C#
public int GetRingSides();

Returns int

GetSidesint

# GetSides

C#
public int GetSides();

Returns int

GetSmoothFacesbool

# GetSmoothFaces

C#
public bool GetSmoothFaces();

Returns bool

SetInnerRadiusvoid

# SetInnerRadius

C#
public void SetInnerRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—

SetMaterialvoid

# SetMaterial

C#
public void SetMaterial(Material material);

Parameters
Name	Type	Default
`material`	`Material`	—

SetOuterRadiusvoid

# SetOuterRadius

C#
public void SetOuterRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—

SetRingSidesvoid

# SetRingSides

C#
public void SetRingSides(int sides);

Parameters
Name	Type	Default
`sides`	`int`	—

SetSidesvoid

# SetSides

C#
public void SetSides(int sides);

Parameters
Name	Type	Default
`sides`	`int`	—

SetSmoothFacesvoid

# SetSmoothFaces

C#
public void SetSmoothFaces(bool smoothFaces);

Parameters
Name	Type	Default
`smoothFaces`	`bool`	—

Reckfell Engine documentationBack to top ↑