OdPrcHelixType1Curve Class

Class Hierarchy

Syntax

C++

class OdPrcHelixType1Curve : public OdPrcCurve3d;

File

PrcHelixType1Curve.h

Description

Class implements a helix with a variable pitch. A helix is a three-dimensional curve defined on an [-infinite, infinite] interval. A helix can be parameterized and transformed for positioning in model space.

Remarks

Transformation can be one of the following:

Value Description

0x00 Identity

0x01 Translate

0x02 Rotate

0x08 Scale

OdPrcHelixType0Curve inherits the OdPrcCurve class and can be reparameterized and trimmed using the OdPrcParameterization class and setParameterization() method.

Group

PRC Curve Classes

Public Methods

	Name	Description
	~OdPrcCurve	Destroys the curve object.

OdPrcHelixType1Curve Class

	Name	Description
	~OdPrcHelixType1Curve	Destroys the helix.

OdPrcCurve Methods

	Name	Description
	contentCurve	This is the overview for the contentCurve method overload.
	is3d	Returns the current curve's 3D flag value. The flag is equal to true if the curve is a 3D object or is equal to false in the other case.
	parameterization	Returns the current parameterization information used for the curve.
	read	Reads curve data from a specified input stream, and creates and returns a curve entity.
	readArray	Reads data from a specified input stream into a curve array.
	readPtr	Reads curve data from a specified input stream, creates a curve, and returns a smart pointer to an OdPrcCurve object.
	setParameterization	Sets new parametrization information to the curve.
	writeArray	Writes data from a curve array to a specified output stream.
	writePtr	Writes curve data to a specified output stream.

OdPrcCurve3d Class

	Name	Description
	createFromOdGeCurve	Creates new 3d curve instance from OdGeCurve3d.
	getGeMatrix3d	Returns the current transformation matrix for the curve.
	getOdGeCurve	Returns the current curve data.
	is3d	Returns the current curve's 3D flag value. The flag is equal to true if curve is a 3D object or is equal to false in the other case.
	setFromOdGeCurve	Sets a new instance of the curve data.
	setTransformation	Sets a new transformation for the curve.
	transformation	Returns the current transformation for the curve.

OdPrcHelixType1Curve Class

	Name	Description
	radiusLaw	Returns the current radius law for the helix. The radius law is used to change the radius according to the angle around the helix.
	setRadiusLaw	Sets a new radius law for the helix. The radius law is used to change the radius according to the angle around the helix.
	setThetaLaw	Sets a new theta law for the helix. The theta law is used to change the radius according to the angle around the helix.
	setTrigonometricOrientation	Sets the trigonometric orientation flag. The trigonometric orientation flag determines the turn direction of the helix. If the flag is set to true, the helix turns in the clockwise direction; if the flag is set to false, it turns in the counter-clockwise direction.
	setUnitU	Sets a new unit_u vector. The unit_u vector determines the X-axis for the helix's coordinate system.
	setUnitZ	Sets a new unit_z vector. The unit_z vector determines the Z-axis for the helix's coordinate system.
	setZLaw	Sets a new z-law for the helix. The z-law is used to change the helix pitch along the Z-axis of the coordinate system.
	start	This is the overview for the start method overload.
	thetaLaw	Returns the current theta law for the helix. The theta law is used to change the radius according to the angle around the helix.
	trigonometricOrientation	Returns the current value of the trigonometric orientation flag. The trigonometric orientation flag determines the turn direction of the helix. If the flag is set to true, the helix turns in the clockwise direction; if the flag is set to false, it turns in the counter-clockwise direction.
	unitU	Returns the current unit_u vector represented as a constant reference to an OdGeVector3d object. The unit_u vector determines the X-axis for the helix's coordinate system.
	unitZ	Returns the current unit_z vector. The unit_z vector determines the Z-axis for the helix's coordinate system.
	zLaw	Returns the current z-law for the helix. The z-law is used to change the helix pitch along the Z-axis of the coordinate system.

Send feedback about this topic