Avara3D 0.2.0
C++ API reference
Tube.h
1//
2// Tube.h
3// avara3d
4//
5// Created by Morgan Davis on 11/8/17.
6// Copyright © 2026 Morgan K Davis. All rights reserved.
7//
8
9#ifndef AVARA3D_MESH_PRIMITIVE_TUBE_H
10#define AVARA3D_MESH_PRIMITIVE_TUBE_H
11
12#include <memory>
13
14#include "a3d/mesh/MeshElement.h"
15
16namespace a3d {
17
18 class Mesh;
19 class Material;
20
28 class Tube : public MeshElement {
29
30 public:
31 // [Public Static Member Functions]
32
34 static std::shared_ptr<Mesh> Mesh(float innerRadius,
35 float outerRadius,
36 float height,
37 unsigned slices = DEFAULT_SLICES,
38 unsigned segments = DEFAULT_SEGMENTS,
39 unsigned rings = DEFAULT_RINGS,
40 std::shared_ptr<Material> material = nullptr);
41
42 // [Public Lifecycle Functions]
43
46 float outerRadius,
47 float height,
48 unsigned slices = DEFAULT_SLICES,
49 unsigned segments = DEFAULT_SEGMENTS,
50 unsigned rings = DEFAULT_RINGS);
51
52 // [Public Member Functions]
53
55 float innerRadius() const;
56
58 float outerRadius() const;
59
61 float height() const;
62
64 unsigned slices() const;
65
67 unsigned segments() const;
68
70 unsigned rings() const;
71
72 private:
73 // [Private Constants]
74
75 static constexpr unsigned DEFAULT_SLICES = 32;
76 static constexpr unsigned DEFAULT_SEGMENTS = 8;
77 static constexpr unsigned DEFAULT_RINGS = 1;
78
79 // [Private Member Variables]
80
81 float _innerRadius;
82 float _outerRadius;
83 float _height;
84 unsigned _slices;
85 unsigned _segments;
86 unsigned _rings;
87 };
88
89}
90
91#endif // AVARA3D_MESH_PRIMITIVE_TUBE_H
Owns the vertex and optional index data for one mesh primitive.
Definition: MeshElement.h:43
Capped hollow tube mesh element centered at the origin and aligned along the Z axis.
Definition: Tube.h:28
unsigned slices() const
Returns the circumferential subdivision count.
float height() const
Returns the configured axial height.
float outerRadius() const
Returns the configured outer radius.
unsigned segments() const
Returns the axial subdivision count.
static std::shared_ptr< Mesh > Mesh(float innerRadius, float outerRadius, float height, unsigned slices=DEFAULT_SLICES, unsigned segments=DEFAULT_SEGMENTS, unsigned rings=DEFAULT_RINGS, std::shared_ptr< Material > material=nullptr)
Creates a Mesh containing a Tube and optional material.
float innerRadius() const
Returns the configured inner radius.
Tube(float innerRadius, float outerRadius, float height, unsigned slices=DEFAULT_SLICES, unsigned segments=DEFAULT_SEGMENTS, unsigned rings=DEFAULT_RINGS)
Generates capped tube geometry with the supplied dimensions and subdivisions.
unsigned rings() const
Returns the radial end-cap subdivision count.