#include <hps.h>

Inheritance diagram for HPS::NURBSCurveKey:
HPS::GeometryKey HPS::Key HPS::Object

Public Member Functions

void Consume (NURBSCurveKit &in_kit)
 
NURBSCurveKeyEditKnotsByReplacement (size_t in_offset, size_t in_count, float const in_knots[])
 
NURBSCurveKeyEditKnotsByReplacement (size_t in_offset, FloatArray const &in_knots)
 
NURBSCurveKeyEditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
 
NURBSCurveKeyEditPointsByReplacement (size_t in_offset, PointArray const &in_points)
 
NURBSCurveKeyEditWeightsByReplacement (size_t in_offset, size_t in_count, float const in_weights[])
 
NURBSCurveKeyEditWeightsByReplacement (size_t in_offset, FloatArray const &in_weights)
 
size_t GetPointCount () const
 
 NURBSCurveKey ()
 
 NURBSCurveKey (Key const &in_that)
 
 NURBSCurveKey (NURBSCurveKey const &in_that)
 
 NURBSCurveKey (NURBSCurveKey &&in_that)
 
HPS::Type ObjectType () const
 
NURBSCurveKeyoperator= (NURBSCurveKey const &in_that)
 
NURBSCurveKeyoperator= (NURBSCurveKey &&in_that)
 
void Set (NURBSCurveKit const &in_kit)
 
NURBSCurveKeySetParameters (float in_start, float in_end)
 
void Show (NURBSCurveKit &out_kit) const
 
bool ShowDegree (size_t &out_degree) const
 
bool ShowKnots (FloatArray &out_knots) const
 
bool ShowParameters (float &out_start, float &out_end) const
 
bool ShowPoints (PointArray &out_points) const
 
bool ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
 
bool ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const
 
bool ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
 
bool ShowWeights (FloatArray &out_weights) const
 
- Public Member Functions inherited from HPS::GeometryKey
 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
GeometryKeyoperator= (GeometryKey const &in_that)
 
GeometryKeyoperator= (GeometryKey &&in_that)
 
GeometryKeySetPriority (int in_priority)
 
GeometryKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
GeometryKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
GeometryKeySetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
bool ShowBounding (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
 
GeometryKeyUnsetAllUserData ()
 
GeometryKeyUnsetPriority ()
 
GeometryKeyUnsetUserData (intptr_t in_index)
 
GeometryKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
GeometryKeyUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Key
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
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::NURBSCurveKey
 
- Static Public Attributes inherited from HPS::GeometryKey
static const HPS::Type staticType = HPS::Type::GeometryKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The NURBSCurveKey class is a smart pointer to a database object. It is a handle to a NURBS curve inserted via SegmentKey::InsertNURBSCurve.

Constructor & Destructor Documentation

◆ NURBSCurveKey() [1/4]

HPS::NURBSCurveKey::NURBSCurveKey ( )

The default constructor creates an uninitialized NURBSCurveKey object. The Type() function will return Type::None.

◆ NURBSCurveKey() [2/4]

HPS::NURBSCurveKey::NURBSCurveKey ( Key const &  in_that)
explicit

This constructor creates a NURBSCurveKey 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 NURBSCurve key. Otherwise the copy will fail and the resulting NURBSCurveKey will be invalid.

Parameters
in_keyThe source Key to copy.

◆ NURBSCurveKey() [3/4]

HPS::NURBSCurveKey::NURBSCurveKey ( NURBSCurveKey const &  in_that)

The copy constructor creates a NURBSCurveKey object that shares the underlying smart-pointer of the source NURBSCurveKey.

Parameters
in_thatThe source NURBSCurveKey to copy.

◆ NURBSCurveKey() [4/4]

HPS::NURBSCurveKey::NURBSCurveKey ( NURBSCurveKey &&  in_that)

The move constructor creates a NURBSCurveKey by transferring the underlying impl of the rvalue reference to this NURBSCurveKey thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a NURBSCurveKey to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::NURBSCurveKey::Consume ( NURBSCurveKit in_kit)

Completely replaces all settings on this NURBSCurveKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this NURBSCurveKey.

◆ EditKnotsByReplacement() [1/2]

NURBSCurveKey& HPS::NURBSCurveKey::EditKnotsByReplacement ( size_t  in_offset,
size_t  in_count,
float const  in_knots[] 
)

Replaces knots for this NURBSCurveKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS curve was inserted.

Parameters
in_offsetThe offset into the knots for this NURBS curve at which to start replacing knots. This value must be such that in_offset<control_point_count+degree+1 for replacement to succeed.
in_countThe number of knots to replace for this NURBS curve. This must be such that in_offset+in_count<=control_point_count+degree+1 for the replacement to succeed.
in_knotsThe knots to use to replace those at the specified offset.
Returns
A reference to this NURBSCurveKey.

◆ EditKnotsByReplacement() [2/2]

NURBSCurveKey& HPS::NURBSCurveKey::EditKnotsByReplacement ( size_t  in_offset,
FloatArray const &  in_knots 
)

Replaces knots for this NURBSCurveKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS curve was inserted.

Parameters
in_offsetThe offset into the knots for this NURBS curve at which to start replacing knots. This value must be such that in_offset<control_point_count+degree+1 for replacement to succeed.
in_knotsThe knots to use to replace those at the specified offset. The size of the array must be such that in_offset+in_knots.size()<=control_point_count+degree+1 for the replacement to succeed.
Returns
A reference to this NURBSCurveKey.

◆ EditPointsByReplacement() [1/2]

NURBSCurveKey& HPS::NURBSCurveKey::EditPointsByReplacement ( size_t  in_offset,
size_t  in_count,
Point const  in_points[] 
)

Replaces control points for this NURBSCurveKey.

Parameters
in_offsetThe offset into the control points for this NURBS curve at which to start replacing points. This value must be such that in_offset<control_point_count for replacement to succeed.
in_countThe number of control points to replace for the NURBS curve. This must be such that such that in_offset+in_count<=control_point_count for the replacement to succeed.
in_pointsThe points to use to replace those in the control point list at the specified offset.
Returns
A reference to this NURBSCurveKey.

◆ EditPointsByReplacement() [2/2]

NURBSCurveKey& HPS::NURBSCurveKey::EditPointsByReplacement ( size_t  in_offset,
PointArray const &  in_points 
)

Replaces control points for this NURBSCurveKey.

Parameters
in_offsetThe offset into the control points for this NURBS curve at which to start replacing points. This value must be such that in_offset<control_point_count for replacement to succeed.
in_pointsThe 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.
Returns
A reference to this NURBSCurveKey.

◆ EditWeightsByReplacement() [1/2]

NURBSCurveKey& HPS::NURBSCurveKey::EditWeightsByReplacement ( size_t  in_offset,
size_t  in_count,
float const  in_weights[] 
)

Replaces control point weights for this NURBSCurveKey. It is possible to edit control point weights even if no weights were specified (i.e., default weights were used) when the NURBS curve was inserted.

Parameters
in_offsetThe offset into the control point weights for this NURBS curve at which to start replacing weights. This value must be such that in_offset<control_point_count for replacement to succeed.
in_countThe number of control point weights to replace for the NURBS curve. This must be such that such that in_offset+in_count<=control_point_count for the replacement to succeed.
in_weightsThe weights to use to replace those in the control point weight list at the specified offset.
Returns
A reference to this NURBSCurveKey.

◆ EditWeightsByReplacement() [2/2]

NURBSCurveKey& HPS::NURBSCurveKey::EditWeightsByReplacement ( size_t  in_offset,
FloatArray const &  in_weights 
)

Replaces control point weights for this NURBSCurveKey. It is possible to edit control point weights even if no weights were specified (i.e., default weights were used) when the NURBS curve was inserted.

Parameters
in_offsetThe offset into the control point weights for this NURBS curve at which to start replacing weights. This value must be such that in_offset<control_point_count for replacement to succeed.
in_weightsThe 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.
Returns
A reference to this NURBSCurveKey.

◆ GetPointCount()

size_t HPS::NURBSCurveKey::GetPointCount ( ) const

Retrieves the number of points in this NURBS curve.

Returns
The number of points in this NURBS curve.

◆ ObjectType()

HPS::Type HPS::NURBSCurveKey::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::GeometryKey.

◆ operator=() [1/2]

NURBSCurveKey& HPS::NURBSCurveKey::operator= ( NURBSCurveKey const &  in_that)

Associate this NURBSCurveKey with the same underlying impl as the source NURBSCurveKey.

Parameters
in_thatThe source NURBSCurveKey for the assignment.
Returns
A reference to this NURBSCurveKey.

◆ operator=() [2/2]

NURBSCurveKey& HPS::NURBSCurveKey::operator= ( NURBSCurveKey &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSCurveKey thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a NURBSCurveKey to take the impl from.
Returns
A reference to this NURBSCurveKey.

◆ Set()

void HPS::NURBSCurveKey::Set ( NURBSCurveKit const &  in_kit)

Replace those settings on this NURBSCurveKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this NURBSCurveKey.

◆ SetParameters()

NURBSCurveKey& HPS::NURBSCurveKey::SetParameters ( float  in_start,
float  in_end 
)

Sets the normalized start and end parameters for this NURBSCurveKey.

Parameters
in_startThe start parameter. This value should be in the range [0,1] and should be defined such that in_start<=in_end.
in_endThe end parameter. This value should be in the range [0,1] and should be defined such that in_start<=in_end.
Returns
A reference to this NURBSCurveKey.

◆ Show()

void HPS::NURBSCurveKey::Show ( NURBSCurveKit out_kit) const

Copy the contents of this NURBSCurveKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this NURBSCurveKey.

◆ ShowDegree()

bool HPS::NURBSCurveKey::ShowDegree ( size_t &  out_degree) const

Shows the degree of this NURBSCurveKey.

Parameters
out_degreeThe degree of this NURBSCurveKey.
Returns
true if a degree was set, false otherwise.

◆ ShowKnots()

bool HPS::NURBSCurveKey::ShowKnots ( FloatArray out_knots) const

Shows the knots for this NURBSCurveKey.

Parameters
out_knotsThe knots for this NURBSCurveKey.
Returns
true if knots were set, false otherwise.

◆ ShowParameters()

bool HPS::NURBSCurveKey::ShowParameters ( float &  out_start,
float &  out_end 
) const

Shows the normalized start and end parameters for this NURBSCurveKey.

Parameters
out_startThe noramlized start parameter for this NURBSCurveKey.
out_endThe noramlized end parameter for this NURBSCurveKey.
Returns
true if start and end parameters were set, false otherwise.

◆ ShowPoints()

bool HPS::NURBSCurveKey::ShowPoints ( PointArray out_points) const

Shows the control points for this NURBSCurveKey.

Parameters
out_pointsThe control points for this NURBSCurveKey.
Returns
true if control points were set, false otherwise.

◆ ShowPointsByList() [1/2]

bool HPS::NURBSCurveKey::ShowPointsByList ( SizeTArray const &  in_indices,
PointArray out_points 
) const

Show a subset of the points for this NURBSCurveKey by list.

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this NURBSCurveKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByList() [2/2]

bool HPS::NURBSCurveKey::ShowPointsByList ( size_t  in_count,
size_t const  in_indices[],
PointArray out_points 
) const

Show a subset of the points for this NURBSCurveKey by list.

Parameters
in_countThe number of points to show.
in_indicesThe list of point indices to show.
out_pointsThe requested points for this NURBSCurveKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

bool HPS::NURBSCurveKey::ShowPointsByRange ( size_t  in_start_index,
size_t  in_count,
PointArray out_points 
) const

Show a subset of the points for this NURBSCurveKey by range.

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this NURBSCurveKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowWeights()

bool HPS::NURBSCurveKey::ShowWeights ( FloatArray out_weights) const

Shows the control point weights for this NURBSCurveKey.

Parameters
out_weightsThe control point weights for this NURBSCurveKey.
Returns
true if control point weights were set, false otherwise.

The documentation for this class was generated from the following file: