.TH "SbCylinderPlaneProjector" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SbCylinderPlaneProjector \- The \fBSbCylinderPlaneProjector\fP class projects 2D points to a half-cylinder and a plane\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/projectors/SbCylinderPlaneProjector\&.h>\fP
.PP
Inherits \fBSbCylinderSectionProjector\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbCylinderPlaneProjector\fP (\fBconst\fP float \fBedgetol\fP=0\&.9f, \fBconst\fP SbBool \fBorienttoeye\fP=TRUE)"
.br
.ti -1c
.RI "\fBSbCylinderPlaneProjector\fP (\fBconst\fP \fBSbCylinder\fP &\fBcyl\fP, \fBconst\fP float \fBedgetol\fP=0\&.9f, \fBconst\fP SbBool \fBorienttoeye\fP=TRUE)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSbProjector\fP * \fBcopy\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSbVec3f\fP \fBproject\fP (\fBconst\fP \fBSbVec2f\fP &point)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSbRotation\fP \fBgetRotation\fP (\fBconst\fP \fBSbVec3f\fP &\fBpoint1\fP, \fBconst\fP \fBSbVec3f\fP &\fBpoint2\fP)"
.br
.in -1c

Public Member Functions inherited from \fBSbCylinderSectionProjector\fP
.in +1c
.ti -1c
.RI "\fBSbCylinderSectionProjector\fP (\fBconst\fP float \fBedgetol\fP=0\&.9f, \fBconst\fP SbBool \fBorienttoeye\fP=TRUE)"
.br
.ti -1c
.RI "\fBSbCylinderSectionProjector\fP (\fBconst\fP \fBSbCylinder\fP &\fBcyl\fP, \fBconst\fP float \fBedgetol\fP=0\&.9f, \fBconst\fP SbBool \fBorienttoeye\fP=TRUE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetTolerance\fP (\fBconst\fP float \fBedgetol\fP)"
.br
.ti -1c
.RI "float \fBgetTolerance\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisWithinTolerance\fP (\fBconst\fP \fBSbVec3f\fP &point)"
.br
.in -1c

Public Member Functions inherited from \fBSbCylinderProjector\fP
.in +1c
.ti -1c
.RI "\fBSbVec3f\fP \fBprojectAndGetRotation\fP (\fBconst\fP \fBSbVec2f\fP &point, \fBSbRotation\fP &\fBrot\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetCylinder\fP (\fBconst\fP \fBSbCylinder\fP &\fBcyl\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbCylinder\fP & \fBgetCylinder\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetOrientToEye\fP (\fBconst\fP SbBool \fBorienttoeye\fP)"
.br
.ti -1c
.RI "SbBool \fBisOrientToEye\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetFront\fP (\fBconst\fP SbBool \fBinfront\fP)"
.br
.ti -1c
.RI "SbBool \fBisFront\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisPointInFront\fP (\fBconst\fP \fBSbVec3f\fP &point) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetWorkingSpace\fP (\fBconst\fP \fBSbMatrix\fP &\fBspace\fP)"
.br
.in -1c

Public Member Functions inherited from \fBSbProjector\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetViewVolume\fP (\fBconst\fP \fBSbViewVolume\fP &\fBvol\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbViewVolume\fP & \fBgetViewVolume\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbMatrix\fP & \fBgetWorkingSpace\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBtryProject\fP (\fBconst\fP \fBSbVec2f\fP &point, \fBconst\fP float epsilon, \fBSbVec3f\fP &result)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBSbRotation\fP \fBgetRotation\fP (\fBconst\fP \fBSbVec3f\fP &\fBpoint1\fP, \fBconst\fP SbBool \fBtol1\fP, \fBconst\fP \fBSbVec3f\fP &\fBpoint2\fP, \fBconst\fP SbBool \fBtol2\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSbCylinderSectionProjector\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetupTolerance\fP (\fBvoid\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSbCylinderProjector\fP
.in +1c
.ti -1c
.RI "\fBSbCylinderProjector\fP (\fBconst\fP SbBool \fBorienttoeye\fP)"
.br
.ti -1c
.RI "\fBSbCylinderProjector\fP (\fBconst\fP \fBSbCylinder\fP &\fBcylinder\fP, \fBconst\fP SbBool \fBorienttoeye\fP)"
.br
.ti -1c
.RI "SbBool \fBintersectCylinderFront\fP (\fBconst\fP \fBSbLine\fP &line, \fBSbVec3f\fP &result)"
.br
.in -1c

Protected Member Functions inherited from \fBSbProjector\fP
.in +1c
.ti -1c
.RI "\fBSbProjector\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SbProjector\fP ()"
.br
.ti -1c
.RI "\fBSbLine\fP \fBgetWorkingLine\fP (\fBconst\fP \fBSbVec2f\fP &point) \fBconst\fP"
.br
.ti -1c
.RI "float \fBfindVanishingDistance\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBverifyProjection\fP (\fBconst\fP \fBSbVec3f\fP &\fBprojpt\fP) \fBconst\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Attributes inherited from \fBSbCylinderSectionProjector\fP
.in +1c
.ti -1c
.RI "float \fBtolerance\fP"
.br
.ti -1c
.RI "float \fBtolDist\fP"
.br
.ti -1c
.RI "\fBSbVec3f\fP \fBplaneDir\fP"
.br
.ti -1c
.RI "\fBSbLine\fP \fBplaneLine\fP"
.br
.ti -1c
.RI "float \fBplaneDist\fP"
.br
.ti -1c
.RI "\fBSbPlane\fP \fBtolPlane\fP"
.br
.in -1c

Protected Attributes inherited from \fBSbCylinderProjector\fP
.in +1c
.ti -1c
.RI "SbBool \fBintersectFront\fP"
.br
.ti -1c
.RI "\fBSbCylinder\fP \fBcylinder\fP"
.br
.ti -1c
.RI "SbBool \fBorientToEye\fP"
.br
.ti -1c
.RI "SbBool \fBneedSetup\fP"
.br
.ti -1c
.RI "\fBSbVec3f\fP \fBlastPoint\fP"
.br
.in -1c

Protected Attributes inherited from \fBSbProjector\fP
.in +1c
.ti -1c
.RI "\fBSbViewVolume\fP \fBviewVol\fP"
.br
.ti -1c
.RI "\fBSbMatrix\fP \fBworldToWorking\fP"
.br
.ti -1c
.RI "\fBSbMatrix\fP \fBworkingToWorld\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSbCylinderPlaneProjector\fP class projects 2D points to a half-cylinder and a plane\&. 

This projector uses a plane along with the half-cylinder of \fBSbCylinderSectionProjector\fP for projections\&. If the 2D point mapping 'misses' the cylinder section, the 3D point will be projected onto the plane\&.
.PP
\fBSee also\fP
.RS 4
\fBSbSpherePlaneProjector\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbCylinderPlaneProjector::SbCylinderPlaneProjector (\fBconst\fP float edgetol = \fC0\&.9f\fP, \fBconst\fP SbBool orienttoeye = \fCTRUE\fP)"
Default constructor\&. See \fBSbCylinderSectionProjector::SbCylinderSectionProjector()\fP\&. 
.SS "SbCylinderPlaneProjector::SbCylinderPlaneProjector (\fBconst\fP \fBSbCylinder\fP & cyl, \fBconst\fP float edgetol = \fC0\&.9f\fP, \fBconst\fP SbBool orienttoeye = \fCTRUE\fP)"
Constructor with explicit specification of projection cylinder\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSbProjector\fP * SbCylinderPlaneProjector::copy (\fBvoid\fP) const\fC [virtual]\fP"
Construct and return a copy of this projector\&. The caller is responsible for destructing the new instance\&.
.PP
\fBNote that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you \fImust\fP make sure that both the Coin DLL and the application executable are using the same instance of a C Run-Time (CRT) library\&. Otherwise, you \fIwill\fP get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes\&.\fP
.br

.br

.PP
Reimplemented from \fBSbCylinderSectionProjector\fP\&.
.SS "\fBSbVec3f\fP SbCylinderPlaneProjector::project (\fBconst\fP \fBSbVec2f\fP & point)\fC [virtual]\fP"
Project the 2D \fIpoint\fP from normalized viewport coordinates to a 3D point\&. The mapping will be done in accordance with the type of the projector\&. 
.PP
Reimplemented from \fBSbCylinderSectionProjector\fP\&.
.SS "\fBSbRotation\fP SbCylinderPlaneProjector::getRotation (\fBconst\fP \fBSbVec3f\fP & point1, \fBconst\fP \fBSbVec3f\fP & point2)\fC [virtual]\fP"
Returns rotation on the projection surface which reorients \fIpoint1\fP to \fIpoint2\fP\&. 
.PP
Reimplemented from \fBSbCylinderSectionProjector\fP\&.
.SS "\fBSbRotation\fP SbCylinderPlaneProjector::getRotation (\fBconst\fP \fBSbVec3f\fP & point1, \fBconst\fP SbBool tol1, \fBconst\fP \fBSbVec3f\fP & point2, \fBconst\fP SbBool tol2)\fC [protected]\fP"
Calculates rotation from \fIpoint1\fP to \fIpoint2\fP, with \fItol1\fP and \fItol2\fP deciding whether or not to use the tolerance setting\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.