|
CFx SDK Documentation 2024 SP0
|
#include <DbBlendOptions.h>
Public Types | |
| enum | DriveModeType { kDriveModeFirst = 0 , kDriveModeSecond = 1 , kDriveModeBoth = 2 } |
Public Member Functions | |
| OdDbBlendOptions () | |
| ~OdDbBlendOptions () | |
| OdDbBlendOptions & | operator= (const OdDbBlendOptions &rhs) |
| bool | simplify () const |
| void | setSimplify (bool simplify) |
| bool | solid () const |
| OdResult | setSolid (bool val) |
| OdUInt32 | quality () const |
| OdResult | setQuality (OdUInt32 val) |
| OdGePoint3d | coplanarPoint () const |
| OdResult | setCoplanarPoint (const OdGePoint3d pPt) |
| OdGeVector3d | coplanarDirection () const |
| OdResult | setCoplanarDirection (const OdGeVector3d pDir) |
| OdDbBlendOptions::DriveModeType | driveMode () const |
| OdResult | setDriveMode (OdDbBlendOptions::DriveModeType val) |
Friends | |
| class | OdDbBlendOptionsImpl |
Class for setting options used for creating blend surfaces and lofted solids (by calling OdDbLoftedSurface::createBlendSurface() or OdDb3dSolid::createBlendSolid() methods). Loft and blend options are used to control the shape of the resulting surface or solid object.
<group OdDb_Classes>
Definition at line 40 of file DbBlendOptions.h.
The drive mode property defines which section(s) "drive" the creation of the planes
containing the planar guides. Any of the two input sections can be selected for
that role, or both of them can be used at the same time (the default value).
The implementation uses the driving sections in conjunction with the coplanar point
and direction (if supplied).
| Enumerator | |
|---|---|
| kDriveModeFirst | |
| kDriveModeSecond | |
| kDriveModeBoth | |
Definition at line 73 of file DbBlendOptions.h.
| OdDbBlendOptions::OdDbBlendOptions | ( | ) |
Creates an OdDbBlendOptions object.
| OdDbBlendOptions::~OdDbBlendOptions | ( | ) |
Copy constructor for the OdDbBlendOptions class.
Destroys the OdDbBlendOptions object.
| OdGeVector3d OdDbBlendOptions::coplanarDirection | ( | ) | const |
The coplanar direction is an optional property that can be supplied to constrain
the set of planes containing the planar guides made by the implementation. If
set, all guide planes will contain it (i.e. are parallel to it). By default no
coplanar direction is set.
| OdGePoint3d OdDbBlendOptions::coplanarPoint | ( | ) | const |
The coplanar point is an optional property that can be supplied to constrain the
set of planes containing the planar guides made by the implementation. If set,
all guide planes will contain it. By default no coplanar point is set. This
option is useful in conjunction with the coplanar direction option to define an
axis contained by all guide planes. An example where such an axis is useful is a
blend operation between involving a cone: The customer application might prefer
that all guides planes to contain the cone axis.
| OdDbBlendOptions::DriveModeType OdDbBlendOptions::driveMode | ( | ) | const |
The drive mode property defines which section(s) "drive" the creation of the
planes containing the planar guides. Any of the two input sections can be
selected for that role, or both of them can be used at the same time (the
default value). The implementation uses the driving sections in conjunction with
the coplanar point and direction (if supplied).
| OdDbBlendOptions & OdDbBlendOptions::operator= | ( | const OdDbBlendOptions & | rhs | ) |
Assigns to the OdDbBlendOptions object another object (assignment operator).
| rhs | [in] Another OdDbBlendOptions object to assign. |
| OdUInt32 OdDbBlendOptions::quality | ( | ) | const |
The quality option controls how many planar curves (aka planar guides) blending
between the input sections are made by the implementation to constrain the
output surface. More planar guides will result in a blend surface that has a
better shape; however, the representation of the surface becomes more complex
which results in larger storage requirements and larger evaluation times. The
default value is 5. The value of 0 has a special meaning: In this case the
output surface will coincide with the standard loft output for the same input
sections and might have a significantly different shape from the surface
produced for a quality value >=1.
| OdResult OdDbBlendOptions::setCoplanarDirection | ( | const OdGeVector3d | pDir | ) |
The coplanar direction is an optional property that can be supplied to constrain
the set of planes containing the planar guides made by the implementation. If
set, all guide planes will contain it (i.e. are parallel to it). By default no
coplanar direction is set.
| pDir | Input specifying AcGeVector3d vector for coplanar direction |
| OdResult OdDbBlendOptions::setCoplanarPoint | ( | const OdGePoint3d | pPt | ) |
The coplanar point is an optional property that can be supplied to constrain the
set of planes containing the planar guides made by the implementation. If set,
all guide planes will contain it. By default no coplanar point is set. This
option is useful in conjunction with the coplanar direction option to define an
axis contained by all guide planes. An example where such an axis is useful is a
blend operation between involving a cone: The customer application might prefer
that all guides planes to contain the cone axis.
| pPt | Input specifying an AcGePoint3d point |
| OdResult OdDbBlendOptions::setDriveMode | ( | OdDbBlendOptions::DriveModeType | val | ) |
The drive mode property defines which section(s) "drive" the creation of the
planes containing the planar guides. Any of the two input sections can be
selected for that role, or both of them can be used at the same time (the
default value). The implementation uses the driving sections in conjunction with
the coplanar point and direction (if supplied).
| val | Input integer of value 0, 1, or 2 representing kDriveModeFirst, kDriveModeSecond or DriveModeBoth respectively. |
The quality option controls how many planar curves (aka planar guides) blending
between the input sections are made by the implementation to constrain the
output surface. More planar guides will result in a blend surface that has a
better shape; however, the representation of the surface becomes more complex
which results in larger storage requirements and larger evaluation times. The
default value is 5. The value of 0 has a special meaning: In this case the
output surface will coincide with the standard loft output for the same input
sections and might have a significantly different shape from the surface
produced for a quality value >=1.
| val | Input specifying a non-negative integer value for quality |
| void OdDbBlendOptions::setSimplify | ( | bool | simplify | ) |
The simplify option allows the application to replace the output ASM procedural
blend spline surface with an analytic surface, but only if the analytic surface
is an exact match. This option is enabled by default.
| val | Input specifying true or false |
| OdResult OdDbBlendOptions::setSolid | ( | bool | val | ) |
The solid option allows the implementation to stitch the output surface to the
input section curves in order to produce a solid body. This function is reserved
for future use. Currently, blend surface always output an surface. It cannot
output solid.
| val | Input specifying true or false |
| bool OdDbBlendOptions::simplify | ( | ) | const |
The simplify option allows the application to replace the output ASM procedural
blend spline surface with an analytic surface, but only if the analytic surface
is an exact match. This option is enabled by default.
| bool OdDbBlendOptions::solid | ( | ) | const |
The solid option allows the implementation to stitch the output surface to the
input section curves in order to produce a solid body. This function is reserved
for future use. Currently, blend surface always output an surface. It cannot
output solid.
|
friend |
Definition at line 219 of file DbBlendOptions.h.