CylinderMesh — C# API

class CylinderMeshReckfellSharpInherits PrimitiveMesh

Class representing a cylindrical PrimitiveMesh.

Class representing a cylindrical PrimitiveMesh. This class can be used to create cones by setting either the CylinderMesh.TopRadius or CylinderMesh.BottomRadius properties to 0.0.

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

Constructors1

CylinderMeshConstructor

# CylinderMesh

C#
public CylinderMesh();

Properties7

BottomRadiusProperty

# BottomRadius

C#
public float BottomRadius { get; set; }

Bottom radius of the cylinder. If set to 0.0, the bottom faces will not be generated, resulting in a conic shape. See also CylinderMesh.CapBottom.

CapBottomProperty

# CapBottom

C#
public bool CapBottom { get; set; }

If true, generates a cap at the bottom of the cylinder. This can be set to false to speed up generation and rendering when the cap is never seen by the camera. See also CylinderMesh.BottomRadius. Note: If CylinderMesh.BottomRadius is 0.0, cap generation is always skipped even if CylinderMesh.CapBottom is true.

CapTopProperty

# CapTop

C#
public bool CapTop { get; set; }

If true, generates a cap at the top of the cylinder. This can be set to false to speed up generation and rendering when the cap is never seen by the camera. See also CylinderMesh.TopRadius. Note: If CylinderMesh.TopRadius is 0.0, cap generation is always skipped even if CylinderMesh.CapTop is true.

HeightProperty

# Height

C#
public float Height { get; set; }

Full height of the cylinder.

RadialSegmentsProperty

# RadialSegments

C#
public int RadialSegments { get; set; }

Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance.

RingsProperty

# Rings

C#
public int Rings { get; set; }

Number of edge rings along the height of the cylinder. Changing CylinderMesh.Rings does not have any visual impact unless a shader or procedural mesh tool is used to alter the vertex data. Higher values result in more subdivisions, which can be used to create smoother-looking effects with shaders or procedural mesh tools (at the cost of performance). When not altering the vertex data using a shader or procedural mesh tool, CylinderMesh.Rings should be kept to its default value.

TopRadiusProperty

# TopRadius

C#
public float TopRadius { get; set; }

Top radius of the cylinder. If set to 0.0, the top faces will not be generated, resulting in a conic shape. See also CylinderMesh.CapTop.

Methods14

GetBottomRadiusfloat

# GetBottomRadius

C#
public float GetBottomRadius();

Returns float

GetHeightfloat

# GetHeight

C#
public float GetHeight();

Returns float

GetRadialSegmentsint

# GetRadialSegments

C#
public int GetRadialSegments();

Returns int

GetRingsint

# GetRings

C#
public int GetRings();

Returns int

GetTopRadiusfloat

# GetTopRadius

C#
public float GetTopRadius();

Returns float

IsCapBottombool

# IsCapBottom

C#
public bool IsCapBottom();

Returns bool

IsCapTopbool

# IsCapTop

C#
public bool IsCapTop();

Returns bool

SetBottomRadiusvoid

# SetBottomRadius

C#
public void SetBottomRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—

SetCapBottomvoid

# SetCapBottom

C#
public void SetCapBottom(bool capBottom);

Parameters
Name	Type	Default
`capBottom`	`bool`	—

SetCapTopvoid

# SetCapTop

C#
public void SetCapTop(bool capTop);

Parameters
Name	Type	Default
`capTop`	`bool`	—

SetHeightvoid

# SetHeight

C#
public void SetHeight(float height);

Parameters
Name	Type	Default
`height`	`float`	—

SetRadialSegmentsvoid

# SetRadialSegments

C#
public void SetRadialSegments(int segments);

Parameters
Name	Type	Default
`segments`	`int`	—

SetRingsvoid

# SetRings

C#
public void SetRings(int rings);

Parameters
Name	Type	Default
`rings`	`int`	—

SetTopRadiusvoid

# SetTopRadius

C#
public void SetTopRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—