textCPL

by Tim C. Lueth, SG-Lib Toolbox: SolidGeometry 5.6 - Visualization
Introduced first in SolidGeometry 4.9, Creation date: 2020-06-16, Last change: 2025-09-14

plots descriptors for each contour into a figure using text command

Description

up to 99 contours are marked at the first point by a letter and a number
same as

See Also: textT , textP , textVL , textCVL , textVLFL , VLFLfaceNormalplot , textVL , textCPS , textSG

Example Illustration

Syntax

h=textCPL(CPL,[c,s,nt,lb])

Input Parameter

`CPL`:		Contour list separated by Nan (CPL/CVL)
`c`:		Color, default is black
`s`:		Size, default is 16
`nt`:		optional list of selected contours
`lb`:		optional string for text; default is 'C'

Output Parameter

h: handle to text

Examples

Different examples for plotting
SGfigure; CPL=CPLsample(12); CPLplotasPS(CPL); textCPL(CPL);

Copyright 2020-2025 Tim C. Lueth. All rights reserved. The code is the property of Tim C. Lueth and may not be redistributed or modified without explicit written permission. This software may be used free of charge for academic research and teaching purposes only. Commercial use, redistribution, modification, or reverse engineering is strictly prohibited. Access to source code is restricted and granted only under specific agreements. For licensing inquiries or commercial use, please contact: Tim C. Lueth

Algorithm (Workflow)

This function, textCPL, is designed to plot descriptors for each contour in a given contour list (CPL) using the text command. It is part of the SG-Library and was introduced in SolidGeometry 4.9. The function is a visualization tool that marks up to 99 contours at their first point with a letter and a number.

Input Parameters

CPL: A contour list separated by NaN values. This is the primary input that defines the contours to be plotted.
c: The color of the text. The default value is black ('k').
s: The size of the text. The default size is 16.
nt: An optional list of selected contours to be marked. By default, it includes all contours separated by NaN.
lb: An optional string for the text label. The default label is 'cpl'.

Output

h: A handle to the text object created by the function.

Function Workflow

The function begins by checking the number of input arguments (nargin) and assigns default values if certain parameters are not provided:

If the color parameter c is not provided, it defaults to black ('k').
If the size parameter s is not provided, it defaults to 16.
If the list of selected contours nt is not provided, it defaults to all contours separated by NaN, determined by the function separateNaN(CPL).
If the label lb is not provided, it defaults to 'cpl'.

The function then calls another function, textCVL, passing the contour list and any additional parameters provided. The handle to the text object created by textCVL is returned as the output.

This function is a work in progress as of July 8, 2025, and is not ready for final release. It is part of a suite of visualization tools that include functions like textT, textP, textVL, and others, which are used for various plotting and visualization tasks in the SG-Library.

Algorithm explaination created using ChatGPT on 2025-08-19 08:16. (Please note: No guarantee for the correctness of this explanation)

Last html export of this page out of FM database by TL: 2025-09-21