MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.Features.Primitives.ConeSegment Class Reference

Public Member Functions

None __init__ (self)
 
None __init__ (self, Features.Primitives.ConeSegment arg0)
 
None __init__ (self, Vector3f referencePoint, Vector3f dir, float positiveSideRadius, float negativeSideRadius, float positiveLength, float negativeLength, bool hollow)
 
Features.Primitives.ConeSegment axis (self)
 
Features.Primitives.ConeSegment baseCircle (self, bool negative)
 
Features.Primitives.Plane basePlane (self, bool negative)
 
Sphere3f basePoint (self, bool negative)
 
Sphere3f centerPoint (self)
 
Features.Primitives.ConeSegment extendToInfinity (self, bool negative)
 
Features.Primitives.ConeSegment extendToInfinity (self)
 
bool isCircle (self)
 
bool isZeroRadius (self)
 
float length (self)
 
Features.Primitives.ConeSegment untruncateCone (self)
 
Vector3f dir (self)
 
None dir (self, Vector3f arg1)
 
bool hollow (self)
 
None hollow (self, bool arg1)
 
float negativeLength (self)
 
None negativeLength (self, float arg1)
 
float negativeSideRadius (self)
 
None negativeSideRadius (self, float arg1)
 
float positiveLength (self)
 
None positiveLength (self, float arg1)
 
float positiveSideRadius (self)
 
None positiveSideRadius (self, float arg1)
 
Vector3f referencePoint (self)
 
None referencePoint (self, Vector3f arg1)
 

Static Public Member Functions

bool __eq__ (*args, **kwargs)
 

Static Protected Member Functions

 _pybind11_conduit_v1_ (*args, **kwargs)
 

Detailed Description

Generated from:  MR::Features::Primitives::ConeSegment

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.

Constructor & Destructor Documentation

◆ __init__() [1/3]

None mrmeshpy.Features.Primitives.ConeSegment.__init__ ( self)
Implicit default constructor.

◆ __init__() [2/3]

None mrmeshpy.Features.Primitives.ConeSegment.__init__ ( self,
Features.Primitives.ConeSegment arg0 )
Implicit copy constructor.

◆ __init__() [3/3]

None mrmeshpy.Features.Primitives.ConeSegment.__init__ ( self,
Vector3f referencePoint,
Vector3f dir,
float positiveSideRadius,
float negativeSideRadius,
float positiveLength,
float negativeLength,
bool hollow )
Implicit aggregate constructor.

Member Function Documentation

◆ __eq__()

bool mrmeshpy.Features.Primitives.ConeSegment.__eq__ ( * args,
** kwargs )
static

◆ _pybind11_conduit_v1_()

mrmeshpy.Features.Primitives.ConeSegment._pybind11_conduit_v1_ ( * args,
** kwargs )
staticprotected

◆ axis()

Features.Primitives.ConeSegment mrmeshpy.Features.Primitives.ConeSegment.axis ( self)
Returns a finite axis. For circles, you might want to immediately `extendToInfinity()` it.

◆ baseCircle()

Features.Primitives.ConeSegment mrmeshpy.Features.Primitives.ConeSegment.baseCircle ( self,
bool negative )
Returns one of the two base circles.

◆ basePlane()

Features.Primitives.Plane mrmeshpy.Features.Primitives.ConeSegment.basePlane ( self,
bool negative )
Returns one of the two base planes.

◆ basePoint()

Sphere3f mrmeshpy.Features.Primitives.ConeSegment.basePoint ( self,
bool negative )
Returns a center of one of the two base circles.

◆ centerPoint()

Sphere3f mrmeshpy.Features.Primitives.ConeSegment.centerPoint ( self)
Returns the center point (unlike `referencePoint`, which can actually be off-center).
For half-infinite objects, returns the finite end.

◆ dir() [1/2]

Vector3f mrmeshpy.Features.Primitives.ConeSegment.dir ( self)
The axis direction. Must be normalized.

◆ dir() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.dir ( self,
Vector3f arg1 )

◆ extendToInfinity() [1/2]

Features.Primitives.ConeSegment mrmeshpy.Features.Primitives.ConeSegment.extendToInfinity ( self)
Extends the object to infinity in both directions. This is equivalent to `.extendToInfinity(false).extendToInfinity(true)`,
except that calling it with `positiveSideRadius != negativeSideRadius` is illegal and triggers an assertion.

◆ extendToInfinity() [2/2]

Features.Primitives.ConeSegment mrmeshpy.Features.Primitives.ConeSegment.extendToInfinity ( self,
bool negative )
Extends the object to infinity in one direction. The radius in the extended direction becomes equal to the radius in the opposite direction.

◆ hollow() [1/2]

bool mrmeshpy.Features.Primitives.ConeSegment.hollow ( self)
If true, the cone has no caps and no volume, and all distances (to the conical surface, that is) are positive.

◆ hollow() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.hollow ( self,
bool arg1 )

◆ isCircle()

bool mrmeshpy.Features.Primitives.ConeSegment.isCircle ( self)

◆ isZeroRadius()

bool mrmeshpy.Features.Primitives.ConeSegment.isZeroRadius ( self)

◆ length()

float mrmeshpy.Features.Primitives.ConeSegment.length ( self)
Returns the length. Can be infinite.

◆ negativeLength() [1/2]

float mrmeshpy.Features.Primitives.ConeSegment.negativeLength ( self)
Distance from the `center` to the cap in the direction opposite to `dir`.

◆ negativeLength() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.negativeLength ( self,
float arg1 )

◆ negativeSideRadius() [1/2]

float mrmeshpy.Features.Primitives.ConeSegment.negativeSideRadius ( self)
Cap radius in the direction opposite to `dir`.

◆ negativeSideRadius() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.negativeSideRadius ( self,
float arg1 )

◆ positiveLength() [1/2]

float mrmeshpy.Features.Primitives.ConeSegment.positiveLength ( self)
Distance from the `center` to the cap in the `dir` direction.

◆ positiveLength() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.positiveLength ( self,
float arg1 )

◆ positiveSideRadius() [1/2]

float mrmeshpy.Features.Primitives.ConeSegment.positiveSideRadius ( self)
Cap radius in the `dir` direction.

◆ positiveSideRadius() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.positiveSideRadius ( self,
float arg1 )

◆ referencePoint() [1/2]

Vector3f mrmeshpy.Features.Primitives.ConeSegment.referencePoint ( self)
Some point on the axis, but not necessarily the true center point. Use `centerPoint()` for that.

◆ referencePoint() [2/2]

None mrmeshpy.Features.Primitives.ConeSegment.referencePoint ( self,
Vector3f arg1 )

◆ untruncateCone()

Features.Primitives.ConeSegment mrmeshpy.Features.Primitives.ConeSegment.untruncateCone ( self)
Untruncates a truncated cone. If it's not a cone at all, returns the object unchanged and triggers an assertion.

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