REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Consume (NURBSSurfaceKit &in_kit) |
NURBSSurfaceKey & | EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[]) |
NURBSSurfaceKey & | EditPointsByReplacement (size_t in_offset, PointArray const &in_points) |
NURBSSurfaceKey & | EditUKnotsByReplacement (size_t in_offset, size_t in_count, float const in_knots[]) |
NURBSSurfaceKey & | EditUKnotsByReplacement (size_t in_offset, FloatArray const &in_knots) |
NURBSSurfaceKey & | EditVKnotsByReplacement (size_t in_offset, size_t in_count, float const in_knots[]) |
NURBSSurfaceKey & | EditVKnotsByReplacement (size_t in_offset, FloatArray const &in_knots) |
NURBSSurfaceKey & | EditWeightsByReplacement (size_t in_offset, size_t in_count, float const in_weights[]) |
NURBSSurfaceKey & | EditWeightsByReplacement (size_t in_offset, FloatArray const &in_weights) |
size_t | GetPointCount () const |
NURBSSurfaceKey () | |
NURBSSurfaceKey (Key const &in_that) | |
NURBSSurfaceKey (NURBSSurfaceKey const &in_that) | |
NURBSSurfaceKey (NURBSSurfaceKey &&in_that) | |
Type | ObjectType () const |
NURBSSurfaceKey & | operator= (NURBSSurfaceKey const &in_that) |
NURBSSurfaceKey & | operator= (NURBSSurfaceKey &&in_that) |
void | Set (NURBSSurfaceKit const &in_kit) |
NURBSSurfaceKey & | SetTrims (size_t in_count, TrimKit const in_trims[]) |
NURBSSurfaceKey & | SetTrims (TrimKitArray const &in_trims) |
void | Show (NURBSSurfaceKit &out_kit) const |
bool | ShowPoints (PointArray &out_points) const |
bool | ShowTrims (TrimKitArray &out_trims) const |
bool | ShowUCount (size_t &out_count) const |
bool | ShowUDegree (size_t &out_degree) const |
bool | ShowUKnots (FloatArray &out_knots) const |
bool | ShowVCount (size_t &out_count) const |
bool | ShowVDegree (size_t &out_degree) const |
bool | ShowVKnots (FloatArray &out_knots) const |
bool | ShowWeights (FloatArray &out_weights) const |
NURBSSurfaceKey & | UnsetTrims () |
![]() | |
GeometryKey () | |
GeometryKey (Key const &in_that) | |
GeometryKey (GeometryKey const &in_that) | |
GeometryKey (GeometryKey &&in_that) | |
GeometryKey & | operator= (GeometryKey const &in_that) |
GeometryKey & | operator= (GeometryKey &&in_that) |
GeometryKey & | SetPriority (int in_priority) |
GeometryKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
GeometryKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
GeometryKey & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
bool | ShowBoundings (BoundingKit &out_kit) const |
bool | ShowPriority (int &out_priority) const |
size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
size_t | ShowReferrers (ReferenceKeyArray &out_references) const |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
size_t | ShowUserDataCount () const |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
GeometryKey & | UnsetAllUserData () |
GeometryKey & | UnsetPriority () |
GeometryKey & | UnsetUserData (intptr_t in_index) |
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
virtual void | Assign (Key const &in_that) |
Key | CopyTo (SegmentKey const &in_destination) const |
void | Delete () |
bool | Equals (Key const &in_that) const |
size_t | GetHash () const |
bool | HasOwner () const |
Key () | |
Key (Key const &in_that) | |
Key (Control const &in_control) | |
Key (Key &&in_that) | |
void | MoveTo (SegmentKey const &in_new_owner) |
bool | operator!= (Key const &in_that) const |
Key & | operator= (Key &&in_that) |
Key & | operator= (Key const &in_that) |
bool | operator== (Key const &in_that) const |
SegmentKey | Owner () const |
SegmentKey | Up () const |
virtual | ~Key () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The NURBSSurfaceKey class is a smart pointer to a database object. It is a handle to a NURBS surface inserted via SegmentKey::InsertNURBSSurface.
NURBSSurfaceKey::NURBSSurfaceKey | ( | ) |
The default constructor creates an uninitialized NURBSSurfaceKey object. The Type() function will return Type::None.
|
explicit |
This constructor creates a NURBSSurfaceKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a NURBSSurface key. Otherwise the copy will fail and the resulting NURBSSurfaceKey will be invalid.
in_key | The source Key to copy. |
NURBSSurfaceKey::NURBSSurfaceKey | ( | NURBSSurfaceKey const & | in_that | ) |
The copy constructor creates a NURBSSurfaceKey object that shares the underlying smart-pointer of the source NURBSSurfaceKey.
in_that | The source NURBSSurfaceKey to copy. |
NURBSSurfaceKey::NURBSSurfaceKey | ( | NURBSSurfaceKey && | in_that | ) |
The move constructor creates a NURBSSurfaceKey by transferring the underlying impl of the rvalue reference to this NURBSSurfaceKey thereby avoiding a copy and allocation.
in_that | An rvalue reference to a NURBSSurfaceKey to take the impl from. |
void NURBSSurfaceKey::Consume | ( | NURBSSurfaceKit & | in_kit | ) |
Completely replaces all settings on this NURBSSurfaceKey with those set on the specified kit and resets the kit.
in_kit | The kit from which to get the settings to replace on this NURBSSurfaceKey. |
NURBSSurfaceKey& NURBSSurfaceKey::EditPointsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Replaces control points for this NURBSSurfaceKey.
in_offset | The offset into the control points for this NURBS surface at which to start replacing points. This value must be such that in_offset<control_point_count for replacement to succeed. |
in_count | The number of control points to replace for the NURBS surface. This must be such that such that in_offset+in_count<=control_point_count for the replacement to succeed. |
in_points | The points to use to replace those in the control point list at the specified offset. |
NURBSSurfaceKey& NURBSSurfaceKey::EditPointsByReplacement | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Replaces control points for this NURBSSurfaceKey.
in_offset | The offset into the control points for this NURBS surface at which to start replacing points. This value must be such that in_offset<control_point_count for replacement to succeed. |
in_points | The points to use to replace those in the control point list at the specified offset. The size of the array must be such that such that in_offset+in_points.size()<=control_point_count for the replacement to succeed. |
NURBSSurfaceKey& NURBSSurfaceKey::EditUKnotsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
float const | in_knots[] | ||
) |
Replaces knots in the U direction for this NURBSSurfaceKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS surface was inserted.
in_offset | The offset into the knots in the U direction for this NURBS surface at which to start replacing knots. This value must be such that in_offset<u_count+u_degree+1 for replacement to succeed. |
in_count | The number of knots in the U direction to replace for this NURBS surface. This must be such that in_offset+in_count<=u_count+u_degree+1 for the replacement to succeed. |
in_knots | The knots in the U direction to use to replace those at the specified offset. |
NURBSSurfaceKey& NURBSSurfaceKey::EditUKnotsByReplacement | ( | size_t | in_offset, |
FloatArray const & | in_knots | ||
) |
Replaces knots in the U direction for this NURBSSurfaceKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS surface was inserted.
in_offset | The offset into the knots in the U direction for this NURBS surface at which to start replacing knots. This value must be such that in_offset<u_count+u_degree+1 for replacement to succeed. |
in_knots | The knots in the U direction to use to replace those at the specified offset. The size of the array must be such that in_offset+in_knots.size()<=u_count+u_degree+1 for the replacement to succeed. |
NURBSSurfaceKey& NURBSSurfaceKey::EditVKnotsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
float const | in_knots[] | ||
) |
Replaces knots in the V direction for this NURBSSurfaceKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS surface was inserted.
in_offset | The offset into the knots in the V direction for this NURBS surface at which to start replacing knots. This value must be such that in_offset<v_count+v_degree+1 for replacement to succeed. |
in_count | The number of knots in the V direction to replace for this NURBS surface. This must be such that in_offset+in_count<=v_count+v_degree+1 for the replacement to succeed. |
in_knots | The knots in the V direction to use to replace those at the specified offset. |
NURBSSurfaceKey& NURBSSurfaceKey::EditVKnotsByReplacement | ( | size_t | in_offset, |
FloatArray const & | in_knots | ||
) |
Replaces knots in the V direction for this NURBSSurfaceKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS surface was inserted.
in_offset | The offset into the knots in the V direction for this NURBS surface at which to start replacing knots. This value must be such that in_offset<v_count+v_degree+1 for replacement to succeed. |
in_knots | The knots in the V direction to use to replace those at the specified offset. The size of the array must be such that in_offset+in_knots.size()<=v_count+v_degree+1 for the replacement to succeed. |
NURBSSurfaceKey& NURBSSurfaceKey::EditWeightsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
float const | in_weights[] | ||
) |
Replaces control point weights for this NURBSSurfaceKey. It is possible to edit control point weights even if no weights were specified (i.e., default weights were used) when the NURBS surface was inserted.
in_offset | The offset into the control point weights for this NURBS surface at which to start replacing weights. This value must be such that in_offset<control_point_count for replacement to succeed. |
in_count | The number of control point weights to replace for the NURBS surface. This must be such that such that in_offset+in_count<=control_point_count for the replacement to succeed. |
in_weights | The weights to use to replace those in the control point weight list at the specified offset. |
NURBSSurfaceKey& NURBSSurfaceKey::EditWeightsByReplacement | ( | size_t | in_offset, |
FloatArray const & | in_weights | ||
) |
Replaces control point weights for this NURBSSurfaceKey. It is possible to edit control point weights even if no weights were specified (i.e., default weights were used) when the NURBS surface was inserted.
in_offset | The offset into the control point weights for this NURBS surface at which to start replacing weights. This value must be such that in_offset<control_point_count for replacement to succeed. |
in_weights | The weights to use to replace those in the control point weight list at the specified offset. The size of the array must be such that such that in_offset+in_weights.size()<=control_point_count for the replacement to succeed. |
size_t NURBSSurfaceKey::GetPointCount | ( | ) | const |
Retrieves the number of points in this NURBS surface.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from GeometryKey.
NURBSSurfaceKey& NURBSSurfaceKey::operator= | ( | NURBSSurfaceKey const & | in_that | ) |
Associate this NURBSSurfaceKey with the same underlying impl as the source NURBSSurfaceKey.
in_that | The source NURBSSurfaceKey for the assignment. |
NURBSSurfaceKey& NURBSSurfaceKey::operator= | ( | NURBSSurfaceKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSSurfaceKey thereby avoiding a copy.
in_that | An rvalue reference to a NURBSSurfaceKey to take the impl from. |
void NURBSSurfaceKey::Set | ( | NURBSSurfaceKit const & | in_kit | ) |
Replace those settings on this NURBSSurfaceKey with those set on the specified kit.
in_kit | The kit from which to get the settings to replace on this NURBSSurfaceKey. |
NURBSSurfaceKey& NURBSSurfaceKey::SetTrims | ( | size_t | in_count, |
TrimKit const | in_trims[] | ||
) |
Sets the specified trims on this NURBSSurfaceKey. These will replace any existing trims.
in_count | Size of the following array. |
in_trims | The array of trims to apply to this NURBSSurfaceKey. |
NURBSSurfaceKey& NURBSSurfaceKey::SetTrims | ( | TrimKitArray const & | in_trims | ) |
Sets the specified trims on this NURBSSurfaceKey. These will replace any existing trims.
in_trims | The array of trims to apply to this NURBSSurfaceKey. |
void NURBSSurfaceKey::Show | ( | NURBSSurfaceKit & | out_kit | ) | const |
Copy the contents of this NURBSSurfaceKey into the specified kit.
out_kit | The kit to populate with the contents of this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowPoints | ( | PointArray & | out_points | ) | const |
Shows the control points for this NURBSSurfaceKey.
out_points | The control points for this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowTrims | ( | TrimKitArray & | out_trims | ) | const |
Shows the trims for this NURBSSurfaceKey.
out_trims | The trims for this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowUCount | ( | size_t & | out_count | ) | const |
Shows the number of control points in the U direction for this NURBSSurfaceKey.
out_count | The number of control points in the U direction for this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowUDegree | ( | size_t & | out_degree | ) | const |
Shows the degree of this NURBSSurfaceKey in the U direction.
out_degree | The degree of this NURBSSurfaceKey in the U direction. |
bool NURBSSurfaceKey::ShowUKnots | ( | FloatArray & | out_knots | ) | const |
Shows the knot sequence in the U direction for this NURBSSurfaceKey.
out_knots | The knot sequence in the U direction for this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowVCount | ( | size_t & | out_count | ) | const |
Shows the number of control points in the V direction for this NURBSSurfaceKey.
out_count | The number of control points in the V direction for this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowVDegree | ( | size_t & | out_degree | ) | const |
Shows the degree of this NURBSSurfaceKey in the V direction.
out_degree | The degree of this NURBSSurfaceKey in the V direction. |
bool NURBSSurfaceKey::ShowVKnots | ( | FloatArray & | out_knots | ) | const |
Shows the knot sequence in the V direction for this NURBSSurfaceKey.
out_knots | The knot sequence in the V direction for this NURBSSurfaceKey. |
bool NURBSSurfaceKey::ShowWeights | ( | FloatArray & | out_weights | ) | const |
Shows the control point weights for this NURBSSurfaceKey.
out_weights | The control point weights for this NURBSSurfaceKey. |
NURBSSurfaceKey& NURBSSurfaceKey::UnsetTrims | ( | ) |
Removes the trims from this NURBSSurfaceKey.