CIP JAVA documentation for class "com.ptc.pfc.pfcGeometry.pfcGeometry"

Class pfcGeometry

package com.ptc.pfc.pfcGeometry; public class pfcGeometry

Description

Contains global CIP definitions for module "pfcGeometry"

Method Summary
`static ArcDescriptor`	`ArcDescriptor_Create (Vector3D Vector1, Vector3D Vector2, Point3D Center, double StartAngle, double EndAngle, double Radius)` This method creates a new ArcDescriptor object.
`static ArrowDescriptor`	`ArrowDescriptor_Create (Point3D End1, Point3D End2)` This method creates a new ArrowDescriptor object.
`static BSplineDescriptor`	`BSplineDescriptor_Create (int Degree, BSplinePoints Points, realseq Knots)` This method creates a new BSplineDescriptor object.
`static BSplinePoint`	`BSplinePoint_Create (Point3D Point, /optional/ Double Weight)` This method creates a new BSpline point object.
`static CircleDescriptor`	`CircleDescriptor_Create (Point3D Center, double Radius, Vector3D UnitNormal)` This method creates a new CircleDescriptor object.
`static CompositeCurveDescriptor`	`CompositeCurveDescriptor_Create (CurveDescriptors Elements)` This method creates a new CompositeCurveDescriptor object.
`static ConeDescriptor`	`ConeDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, double Alpha)` This method creates a new ConeDescriptor object.
`static CoonsPatchDescriptor`	`CoonsPatchDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, CurveDescriptor U0Profile, CurveDescriptor U1Profile, CurveDescriptor V0Profile, CurveDescriptor V1Profile, CoonsCornerPoints CornerPoints, CoonsUVDerivatives UVDerivatives)` This method returns a new CoonsPatchDescriptor object.
`static CylinderDescriptor`	`CylinderDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, double Radius)` This method creates a new CylinderDescriptor object.
`static CylindricalSplineSurfaceDescriptor`	`CylindricalSplineSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, SplineSurfaceDescriptor SplineSurfaceData)` This method creates a new CylindricalSplineSurfaceDescriptor object.
`static EllipseDescriptor`	`EllipseDescriptor_Create (Point3D Center, Vector3D UnitMajorAxis, Vector3D UnitNormal, double MajorLength, double MinorLength, double StartAngle, double EndAngle)` This method returns a new EllipseDescriptor object.
`static FilletSurfaceDescriptor`	`FilletSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, SplineDescriptor U0Profile, SplineDescriptor CenterProfile, SplineDescriptor TangentProfile)` This method creates a new FilletSurfaceDescriptor object.
`static ForeignSurfaceDescriptor`	`ForeignSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, int ForeignID)` This method creates a new ForeignSurfaceDescriptor object.
`static LineDescriptor`	`LineDescriptor_Create (Point3D End1, Point3D End2)` This method creates a new LineDescriptor object.
`static NURBSSurfaceDescriptor`	`NURBSSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, int UDegree, int VDegree, realseq UKnots, realseq VKnots, BSplinePoints Points)` This method creates a new NURBSSurfaceDescriptor object.
`static PlaneDescriptor`	`PlaneDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin)` Method to create a set of information describing a planar surface.
`static PointDescriptor`	`PointDescriptor_Create (Point3D Point)` This method creates a new PointDescriptor object.
`static PolygonDescriptor`	`PolygonDescriptor_Create (Point3Ds Vertices)` This method creates a new PolygonDescriptor object.
`static RevolvedSurfaceDescriptor`	`RevolvedSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, CurveDescriptor Profile)` This method creates a new RevolvedSurfaceDescriptor object.
`static RuledSurfaceDescriptor`	`RuledSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, CurveDescriptor Profile1, CurveDescriptor Profile2)` This method creates a new RuledSurfaceDescriptor object.
`static SphericalSplineSurfaceDescriptor`	`SphericalSplineSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, SplineSurfaceDescriptor SplineSurfaceData)` This method creates a new SphericalSplineSurfaceDescriptor object.
`static SplineDescriptor`	`SplineDescriptor_Create (SplinePoints Points)` This method creates a new SplineDescriptor object.
`static SplinePoint`	`SplinePoint_Create (double Parameter, Point3D Point, Vector3D Tangent)` This method creates a new spline point object.
`static SplineSurfaceDescriptor`	`SplineSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, SplineSurfacePoints Points)` This method creates a new SplineSurfaceDescriptor object.
`static SplineSurfacePoint`	`SplineSurfacePoint_Create (UVParams Parameter, Point3D Point, Vector3D UTangent, Vector3D VTangent, Vector3D UVDerivative)` This method creates a new SplineSurfacePoint object.
`static SurfaceExtents`	`SurfaceExtents_Create (UVOutline UVExtents)` This method creates a new SurfaceExtents object.
`static TabulatedCylinderDescriptor`	`TabulatedCylinderDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, CurveDescriptor Profile)` This method creates a new TabulatedCylinderDescriptor object.
`static TextDescriptor`	`TextDescriptor_Create (String TextString, Point3D Point, TextStyle Style)` This method creates a new TextDescriptor object.
`static TorusDescriptor`	`TorusDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, double Radius1, double Radius2)` This method creates a new TorusDescriptor object.

Method Detail

SplineSurfacePoint_Create

static SplineSurfacePoint SplineSurfacePoint_Create (UVParams Parameter, Point3D Point, Vector3D UTangent, Vector3D VTangent, Vector3D UVDerivative)

This method creates a new SplineSurfacePoint object.

Parameters:

Parameter: The UV parameters of the point on the surface.
Point: The XYZ point
UTangent: The tangent vector in the U direction at the point
VTangent: The tangent vector in the V direction at the point
UVDerivative: The mixed derivative at the point

Returns:: The new SplineSurfacePoint object

BSplinePoint_Create

static BSplinePoint BSplinePoint_Create (Point3D Point, /*optional*/ Double Weight)

This method creates a new BSpline point object.

Parameters:

Point: The point coordinates
Weight: The weight

Returns:: The new BSplinePoint object

SurfaceExtents_Create

static SurfaceExtents SurfaceExtents_Create (UVOutline UVExtents)

This method creates a new SurfaceExtents object.

Parameters:

UVExtents: The UV parameters at the corners of the surface.

Returns:: The new SurfaceExtents object.

PlaneDescriptor_Create

static PlaneDescriptor PlaneDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin)

Method to create a set of information describing a planar surface.

Parameters:

Extents
Orientation
Origin

Returns:

CylinderDescriptor_Create

static CylinderDescriptor CylinderDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, double Radius)

This method creates a new CylinderDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
Radius: The surface radius

Returns:: The new CylinderDescriptor object

ConeDescriptor_Create

static ConeDescriptor ConeDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, double Alpha)

This method creates a new ConeDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
Alpha: The cone angle

Returns:: The new ConeDescriptor object

TorusDescriptor_Create

static TorusDescriptor TorusDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, double Radius1, double Radius2)

This method creates a new TorusDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
Radius1: The distance from the center of the generating arc to the axis of revolution
Radius2: The radius of the generating arc

Returns:: The new TorusDescriptor object

RevolvedSurfaceDescriptor_Create

static RevolvedSurfaceDescriptor RevolvedSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, CurveDescriptor Profile)

This method creates a new RevolvedSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
Profile: The geometry of the generating curve

Returns:: The new RevolvedSurfaceDescriptor object

RuledSurfaceDescriptor_Create

static RuledSurfaceDescriptor RuledSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, CurveDescriptor Profile1, CurveDescriptor Profile2)

This method creates a new RuledSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
Profile1: The geometry of the first generating curve
Profile2: The geometry of the second generating curve

Returns:: The new RuledSurfaceDescriptor object

TabulatedCylinderDescriptor_Create

static TabulatedCylinderDescriptor TabulatedCylinderDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, CurveDescriptor Profile)

This method creates a new TabulatedCylinderDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
Profile: The geometry of the curve that is projected

Returns:

CoonsPatchDescriptor_Create

static CoonsPatchDescriptor CoonsPatchDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, CurveDescriptor U0Profile, CurveDescriptor U1Profile, CurveDescriptor V0Profile, CurveDescriptor V1Profile, CoonsCornerPoints CornerPoints, CoonsUVDerivatives UVDerivatives)

This method returns a new CoonsPatchDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
U0Profile: The geometry at the U=0 boundary
U1Profile: The geometry at the U=1 boundary
V0Profile: The geometry at the V=0 boundary
V1Profile: The geometry at the V=1 boundary
CornerPoints: The Coons path corner points
UVDerivatives: The corner UV derivatives

Returns:: The new CoonsPatchDescriptor object

FilletSurfaceDescriptor_Create

static FilletSurfaceDescriptor FilletSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, SplineDescriptor U0Profile, SplineDescriptor CenterProfile, SplineDescriptor TangentProfile)

This method creates a new FilletSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
U0Profile: The geoemtry of along the u=0 boundary
CenterProfile: The geometry along the centers of the fillet arcs
TangentProfile: The geometry of the unit tangents to the axis of the fillet arcs

Returns:: The new FilletSurfaceDescriptor object

SplineSurfaceDescriptor_Create

static SplineSurfaceDescriptor SplineSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, SplineSurfacePoints Points)

This method creates a new SplineSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Points: An array of spline interpolant points and derivatives

Returns:: The new SplineSurfaceDescriptor object

NURBSSurfaceDescriptor_Create

static NURBSSurfaceDescriptor NURBSSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, int UDegree, int VDegree, realseq UKnots, realseq VKnots, BSplinePoints Points)

This method creates a new NURBSSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
UDegree: The degree of the U basis function
VDegree: The degree of the V basis function
UKnots: The knots on the parameter line U
VKnots: The knots on the parameter line V
Points: The control point array

Returns:: The new NURBSSurfaceDescriptor object

CylindricalSplineSurfaceDescriptor_Create

static CylindricalSplineSurfaceDescriptor CylindricalSplineSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, SplineSurfaceDescriptor SplineSurfaceData)

This method creates a new CylindricalSplineSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
SplineSurfaceData: The spline surface geometry to use

Returns:: The new CylindricalSplineSurfaceDescriptor object

SphericalSplineSurfaceDescriptor_Create

static SphericalSplineSurfaceDescriptor SphericalSplineSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, SplineSurfaceDescriptor SplineSurfaceData)

This method creates a new SphericalSplineSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
SplineSurfaceData: The spline surface geometry

Returns:: The new SphericalSplineSurfaceDescriptor object

ForeignSurfaceDescriptor_Create

static ForeignSurfaceDescriptor ForeignSurfaceDescriptor_Create (SurfaceExtents Extents, SurfaceOrientation Orientation, Transform3D Origin, int ForeignID)

This method creates a new ForeignSurfaceDescriptor object.

Parameters:

Extents: The surface extents
Orientation: The surface orientation
Origin: The coordinate system of the surface
ForeignID: The foreign surface id

Returns:: The new ForeignSurfaceDescriptor object

SplinePoint_Create

static SplinePoint SplinePoint_Create (double Parameter, Point3D Point, Vector3D Tangent)

This method creates a new spline point object.

Parameters:

Parameter: The spline parameter at the point.
Point: The splie point.
Tangent: The tangent vector at the point.

Returns:: The new SplinePoint object.

CompositeCurveDescriptor_Create

static CompositeCurveDescriptor CompositeCurveDescriptor_Create (CurveDescriptors Elements)

This method creates a new CompositeCurveDescriptor object.

Parameters:

Elements: The geometry of the curves making up the composite curve

Returns:: The new CompositeCurveDescriptor object.

PointDescriptor_Create

static PointDescriptor PointDescriptor_Create (Point3D Point)

This method creates a new PointDescriptor object.

Parameters:

Point: The point

Returns:: The new PointDescriptor object.

LineDescriptor_Create

static LineDescriptor LineDescriptor_Create (Point3D End1, Point3D End2)

This method creates a new LineDescriptor object.

Parameters:

End1: The first endpoint
End2: The second endpoint

Returns:: The new LineDescriptor object

ArrowDescriptor_Create

static ArrowDescriptor ArrowDescriptor_Create (Point3D End1, Point3D End2)

This method creates a new ArrowDescriptor object.

See Also:: DetailEntityInstructions

Parameters:

End1: The first endpoint
End2: The second endpoint

Returns:: The new ArrowDescriptor object

ArcDescriptor_Create

static ArcDescriptor ArcDescriptor_Create (Vector3D Vector1, Vector3D Vector2, Point3D Center, double StartAngle, double EndAngle, double Radius)

This method creates a new ArcDescriptor object.

See Also:: DetailEntityInstructions

Parameters:

Vector1: The first vector that defines the plane of the arc
Vector2: The second vector that defines the plane of the arc
Center: The arc center
StartAngle: The start angle
EndAngle: The arc end angle
Radius: The radius

Returns:: The new ArcDescriptor object

SplineDescriptor_Create

static SplineDescriptor SplineDescriptor_Create (SplinePoints Points)

This method creates a new SplineDescriptor object.

Parameters:

Points: The array of spline points

Returns:: The new SplineDescriptor

BSplineDescriptor_Create

static BSplineDescriptor BSplineDescriptor_Create (int Degree, BSplinePoints Points, realseq Knots)

This method creates a new BSplineDescriptor object.

Parameters:

Degree: The B-Spline degree
Points: The array of control points
Knots: The array of knots

Returns:: The new BSplineDescriptor object

CircleDescriptor_Create

static CircleDescriptor CircleDescriptor_Create (Point3D Center, double Radius, Vector3D UnitNormal)

This method creates a new CircleDescriptor object.

Parameters:

Center: The circle center
Radius: The circle radius
UnitNormal: The normal vector to the circle

Returns:: The new CircleDescriptor object

EllipseDescriptor_Create

static EllipseDescriptor EllipseDescriptor_Create (Point3D Center, Vector3D UnitMajorAxis, Vector3D UnitNormal, double MajorLength, double MinorLength, double StartAngle, double EndAngle)

This method returns a new EllipseDescriptor object.

Parameters:

Center: The ellipse center
UnitMajorAxis: The unit major axis
UnitNormal: The unit normal
MajorLength: The axis major length
MinorLength: The axis minor length
StartAngle: The start angle
EndAngle: The end angle

Returns:: The new EllipseDescriptor object

PolygonDescriptor_Create

static PolygonDescriptor PolygonDescriptor_Create (Point3Ds Vertices)

This method creates a new PolygonDescriptor object.

Parameters:

Vertices: The polygon vertices

Returns:: The new PolygonDescriptor object

TextDescriptor_Create

static TextDescriptor TextDescriptor_Create (String TextString, Point3D Point, TextStyle Style)

This method creates a new TextDescriptor object.

Parameters:

TextString: The text string
Point: The location of the text
Style: The text style

Returns:: The new TextDescriptor object