PolyLine Class Reference

Clothoids: PolyLine Class Reference
Clothoids
Public Member Functions | List of all members
PolyLine Class Reference
Inheritance diagram for PolyLine:
CurveBase

Public Member Functions

function PolyLine (in)
 MATLAB class wrapper for the underlying C++ class.
 
function build (in self, in x, in y)
 
function approx (in self, in obj, in tol)
 
function polygon (in self)
 
function s_to_index (in self, in s)
 
function plot (in self, in varargin)
 
- Public Member Functions inherited from CurveBase
function CurveBase (in mexName, in objectType)
 
function obj_handle (in self)
 
function is_type (in self)
 
function load (in self, in OBJ)
 
function bbox (in self, in varargin)
 
function translate (in self, in tx, in ty)
 
function trim (in self, in smin, in smax)
 
function rotate (in self, in angle, in cx, in cy)
 
function reverse (in self)
 
function scale (in self, in sc)
 
function change_origin (in self, in newX0, in newY0)
 
function changeOrigin (in self, in newX0, in newY0)
 
function evaluate (in self, in s, in varargin)
 
function eval (in self, in varargin)
 
function eval_D (in self, in varargin)
 
function eval_DD (in self, in varargin)
 
function eval_DDD (in self, in varargin)
 
function theta (in self, in s)
 
function theta_D (in self, in s)
 
function theta_DD (in self, in s)
 
function theta_DDD (in self, in s)
 
function kappa (in self, in s)
 
function kappa_D (in self, in s)
 
function kappa_DD (in self, in s)
 
function xy_begin (in self)
 
function xyBegin (in self)
 
function xy_end (in self)
 
function xyEnd (in self)
 
function x_begin (in self)
 
function xBegin (in self)
 
function x_end (in self)
 
function xEnd (in self)
 
function y_begin (in self)
 
function yBegin (in self)
 
function y_end (in self)
 
function yEnd (in self)
 
function theta_begin (in self)
 
function thetaBegin (in self)
 
function theta_end (in self)
 
function thetaEnd (in self)
 
function kappa_begin (in self)
 
function kappaBegin (in self)
 
function kappa_end (in self)
 
function kappaEnd (in self)
 
function length (in self, in varargin)
 
function points (in self)
 
function bbTriangles (in self, in varargin)
 
function closest_point (in self, in qx, in qy, in varargin)
 
function closestPoint (in self, in qx, in qy, in varargin)
 
function distance (in self, in qx, in qy, in varargin)
 
function collision (in self, in OBJ, in varargin)
 
function intersect (in self, in OBJ, in varargin)
 
function info (in self)
 
function find_coord (in self, in x, in y)
 
function yesAABBtree (in self)
 
function noAABBtree (in self)
 
function plot_tbox (in self, in P1, in P2, in P3, in varargin)
 
function plotTBox (in self, in P1, in P2, in P3, in varargin)
 
function plot_bbox (in self, in varargin)
 
function plotBBox (in self, in varargin)
 
function plot_triangles (in self, in varargin)
 
function plotTriangles (in self, in varargin)
 

Additional Inherited Members

- Protected Member Functions inherited from CurveBase
function copyElement (in self)
 
- Protected Attributes inherited from CurveBase
Property mexName
 
Property objectHandle
 
Property call_delete
 
Property objectType
 

Constructor & Destructor Documentation

◆ PolyLine()

function PolyLine::PolyLine ( in )

MATLAB class wrapper for the underlying C++ class.

Create a new C++ class instance for the polyline object

Usage:

ref = PolyLine()

On output:

  • ref: reference handle to the object instance

Member Function Documentation

◆ approx()

function PolyLine::approx ( in self,
in obj,
in tol )

Approximate a curve of type

with a polyline

Usage:

ref.approx( obj, tol );
  • obj: object storing the curve
  • tol: tolerance admitted

◆ build()

function PolyLine::build ( in self,
in x,
in y )

Build a polyline object given a list of points

Usage:

ref.build( x, y );
  • x: vector of x-coordinates of the points
  • y: vector of y-coordinates of the points

◆ plot()

function PolyLine::plot ( in self,
in varargin )

Plot the polyline

Usage:

ref.plot();
fmt1 = {'Color','blue','Linewidth',2}; % first arc of the biarc
fmt2 = {'Color','red','Linewidth',2}; % second arc of the biarc
ref.plot( fmt1, fmt2 );
  • fmt1: format of the odd segment
  • fmt2: format of the even segment

◆ polygon()

function PolyLine::polygon ( in self)

Return the points of the polyline (the polygon)

◆ s_to_index()

function PolyLine::s_to_index ( in self,
in s )

Return the index of the segment containing s curvilinear abscissa

The documentation for this class was generated from the following file:
  • /Users/enrico/Ricerca/develop/PINS/pins-mechatronix/LibSources/submodules/Clothoids/toolbox/lib/PolyLine.m
Generated by doxygen 1.12.0