Back to Aurora Vision Library website

You are here: Start » Function Reference » Geometry 3D » Geometry 3D Spatial Transforms » RescaleSegment3D

RescaleSegment3D


Header: AVL.h
Namespace: avl
Module: Vision3DLite

Lengthens or shortens a segment in 3D relatively.

Syntax

C++
C#
 
void avl::RescaleSegment3D
(
	const avl::Segment3D& inSegment3D,
	atl::Optional<const avl::Point3D&> inReferencePoint,
	float inScale,
	bool inInverse,
	avl::Segment3D& outSegment3D
)

Parameters

Name Type Default Description
Input value inSegment3D const Segment3D& Input segment in 3D
Input value inReferencePoint Optional<const Point3D&> NIL The point to which all distances change linearly (the mass center by default)
Input value inScale float 1.0f Scaling factor (negative values invert the segment)
Input value inInverse bool Switches to the inverse operation
Output value outSegment3D Segment3D&

In-place Processing

This function supports in-place data processing - you can pass the same reference to inSegment3D and outSegment3D

Read more about In-place Computation.

Errors

List of possible exceptions:

Error type Description
DomainError Scale cannot be zero in an inverse rescaling of a segment in RescaleSegment3D.