MeshLib C++ Docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Friends | List of all members
MR::Features::Primitives::ConeSegment Struct Reference

#include <MRFeatures.h>

Public Member Functions

bool isZeroRadius () const
 
bool isCircle () const
 
float length () const
 
MRMESH_API Sphere centerPoint () const
 
MRMESH_API ConeSegment extendToInfinity (bool negative) const
 
MRMESH_API ConeSegment extendToInfinity () const
 
MRMESH_API ConeSegment untruncateCone () const
 
MRMESH_API ConeSegment axis () const
 
MRMESH_API Sphere basePoint (bool negative) const
 
MRMESH_API Plane basePlane (bool negative) const
 
MRMESH_API ConeSegment baseCircle (bool negative) const
 

Public Attributes

Vector3f referencePoint
 Some point on the axis, but not necessarily the true center point. Use centerPoint() for that.
 
Vector3f dir
 The axis direction. Must be normalized.
 
float positiveSideRadius = 0
 Cap radius in the dir direction.
 
float negativeSideRadius = 0
 Cap radius in the direction opposite to dir.
 
float positiveLength = 0
 Distance from the center to the cap in the dir direction.
 
float negativeLength = 0
 Distance from the center to the cap in the direction opposite to dir.
 
bool hollow = false
 

Friends

bool operator== (const ConeSegment &, const ConeSegment &)=default
 

Detailed Description

Can have infinite length in one or two directions. The top and/or bottom can be flat or pointy. Doubles as a cylinder, line (finite or infinite), and a circle.

Member Function Documentation

◆ axis()

MRMESH_API ConeSegment MR::Features::Primitives::ConeSegment::axis ( ) const
nodiscard

◆ baseCircle()

MRMESH_API ConeSegment MR::Features::Primitives::ConeSegment::baseCircle ( bool negative) const
nodiscard

◆ basePlane()

MRMESH_API Plane MR::Features::Primitives::ConeSegment::basePlane ( bool negative) const
nodiscard

◆ basePoint()

MRMESH_API Sphere MR::Features::Primitives::ConeSegment::basePoint ( bool negative) const
nodiscard

◆ centerPoint()

MRMESH_API Sphere MR::Features::Primitives::ConeSegment::centerPoint ( ) const
nodiscard

◆ extendToInfinity() [1/2]

MRMESH_API ConeSegment MR::Features::Primitives::ConeSegment::extendToInfinity ( ) const
nodiscard

◆ extendToInfinity() [2/2]

MRMESH_API ConeSegment MR::Features::Primitives::ConeSegment::extendToInfinity ( bool negative) const
nodiscard

◆ isCircle()

bool MR::Features::Primitives::ConeSegment::isCircle ( ) const
inlinenodiscard

◆ isZeroRadius()

bool MR::Features::Primitives::ConeSegment::isZeroRadius ( ) const
inlinenodiscard

◆ length()

float MR::Features::Primitives::ConeSegment::length ( ) const
inlinenodiscard

◆ untruncateCone()

MRMESH_API ConeSegment MR::Features::Primitives::ConeSegment::untruncateCone ( ) const
nodiscard

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const ConeSegment & ,
const ConeSegment &  )
friend

Member Data Documentation

◆ dir

Vector3f MR::Features::Primitives::ConeSegment::dir

The axis direction. Must be normalized.

◆ hollow

bool MR::Features::Primitives::ConeSegment::hollow = false

◆ negativeLength

float MR::Features::Primitives::ConeSegment::negativeLength = 0

Distance from the center to the cap in the direction opposite to dir.

◆ negativeSideRadius

float MR::Features::Primitives::ConeSegment::negativeSideRadius = 0

Cap radius in the direction opposite to dir.

◆ positiveLength

float MR::Features::Primitives::ConeSegment::positiveLength = 0

Distance from the center to the cap in the dir direction.

◆ positiveSideRadius

float MR::Features::Primitives::ConeSegment::positiveSideRadius = 0

Cap radius in the dir direction.

◆ referencePoint

Vector3f MR::Features::Primitives::ConeSegment::referencePoint

Some point on the axis, but not necessarily the true center point. Use centerPoint() for that.

The documentation for this struct was generated from the following file: