Public Member Functions | Properties | List of all members
Plane3D Class Reference

A plane in 3D space in Hessian normal form. More...

Inherits object.

Public Member Functions

float distance_to_point (self, cvb.Point3D pt)
 Calculates the distance to the point pt. More...
 

Properties

 distance_to_origin = property
 float: Gets or sets the distance to the origin in point units. More...
 
 normal = property
 cvb.Point3D: Gets or sets the normal vector of the plane. More...
 

Detailed Description

A plane in 3D space in Hessian normal form.

Creates a new Plane3D object from the given normal vector components and the distanceToOrigin.

Parameters

nx : float Normal vector x component.

ny : float Normal vector y component.

nz : float Normal vector z component.

distance_to_origin : float Distance to origin in point units.

Member Function Documentation

◆ distance_to_point()

float distance_to_point (   self,
cvb.Point3D  pt 
)

Calculates the distance to the point pt.

Parameters

pt : cvb.Point3D Point to calculate the distance to.

Returns

float The distance to the specified point.

Calculates the distance to the point pt.

Parameters

x : float Point x component.

y : float Point y component.

z : float Point z component.

Returns

float The distance to the specified point.

Property Documentation

◆ distance_to_origin

distance_to_origin = property
static

float: Gets or sets the distance to the origin in point units.

◆ normal

normal = property
static

cvb.Point3D: Gets or sets the normal vector of the plane.