HPS::NURBSSurfaceKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::NURBSSurfaceKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (NURBSSurfaceKit &in_kit)
 
NURBSSurfaceKitEditPointsByDeletion (size_t in_offset, size_t in_count)
 
NURBSSurfaceKitEditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
 
NURBSSurfaceKitEditPointsByInsertion (size_t in_offset, PointArray const &in_points)
 
NURBSSurfaceKitEditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
 
NURBSSurfaceKitEditPointsByReplacement (size_t in_offset, PointArray const &in_points)
 
NURBSSurfaceKitEditUKnotsByDeletion (size_t in_offset, size_t in_count)
 
NURBSSurfaceKitEditUKnotsByInsertion (size_t in_offset, size_t in_count, float const in_knots[])
 
NURBSSurfaceKitEditUKnotsByInsertion (size_t in_offset, FloatArray const &in_knots)
 
NURBSSurfaceKitEditUKnotsByReplacement (size_t in_offset, size_t in_count, float const in_knots[])
 
NURBSSurfaceKitEditUKnotsByReplacement (size_t in_offset, FloatArray const &in_knots)
 
NURBSSurfaceKitEditVKnotsByDeletion (size_t in_offset, size_t in_count)
 
NURBSSurfaceKitEditVKnotsByInsertion (size_t in_offset, size_t in_count, float const in_knots[])
 
NURBSSurfaceKitEditVKnotsByInsertion (size_t in_offset, FloatArray const &in_knots)
 
NURBSSurfaceKitEditVKnotsByReplacement (size_t in_offset, size_t in_count, float const in_knots[])
 
NURBSSurfaceKitEditVKnotsByReplacement (size_t in_offset, FloatArray const &in_knots)
 
NURBSSurfaceKitEditWeightsByDeletion (size_t in_offset, size_t in_count)
 
NURBSSurfaceKitEditWeightsByInsertion (size_t in_offset, size_t in_count, float const in_weights[])
 
NURBSSurfaceKitEditWeightsByInsertion (size_t in_offset, FloatArray const &in_weights)
 
NURBSSurfaceKitEditWeightsByReplacement (size_t in_offset, size_t in_count, float const in_weights[])
 
NURBSSurfaceKitEditWeightsByReplacement (size_t in_offset, FloatArray const &in_weights)
 
bool Empty () const
 
bool Equals (NURBSSurfaceKit const &in_kit) const
 
size_t GetPointCount () const
 
 NURBSSurfaceKit ()
 
 NURBSSurfaceKit (NURBSSurfaceKit const &in_kit)
 
 NURBSSurfaceKit (NURBSSurfaceKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (NURBSSurfaceKit const &in_kit) const
 
NURBSSurfaceKitoperator= (NURBSSurfaceKit &&in_that)
 
NURBSSurfaceKitoperator= (NURBSSurfaceKit const &in_kit)
 
bool operator== (NURBSSurfaceKit const &in_kit) const
 
void Set (NURBSSurfaceKit const &in_kit)
 
NURBSSurfaceKitSetPoints (PointArray const &in_points)
 
NURBSSurfaceKitSetPoints (size_t in_count, Point const in_points [])
 
NURBSSurfaceKitSetPriority (int in_priority)
 
NURBSSurfaceKitSetTrim (TrimKit const &in_trim)
 
NURBSSurfaceKitSetTrims (TrimKitArray const &in_trims)
 
NURBSSurfaceKitSetTrims (size_t in_count, TrimKit const in_trims [])
 
NURBSSurfaceKitSetUCount (size_t in_count)
 
NURBSSurfaceKitSetUDegree (size_t in_degree)
 
NURBSSurfaceKitSetUKnots (FloatArray const &in_knots)
 
NURBSSurfaceKitSetUKnots (size_t in_count, float const in_knots [])
 
NURBSSurfaceKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
NURBSSurfaceKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 
NURBSSurfaceKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
NURBSSurfaceKitSetVCount (size_t in_count)
 
NURBSSurfaceKitSetVDegree (size_t in_degree)
 
NURBSSurfaceKitSetVKnots (FloatArray const &in_knots)
 
NURBSSurfaceKitSetVKnots (size_t in_count, float const in_knots [])
 
NURBSSurfaceKitSetWeights (FloatArray const &in_weights)
 
NURBSSurfaceKitSetWeights (size_t in_count, float const in_weights [])
 
void Show (NURBSSurfaceKit &out_kit) 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 ShowPriority (int &out_priority) 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 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
 
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
 
NURBSSurfaceKitUnsetAllUserData ()
 
NURBSSurfaceKitUnsetEverything ()
 
NURBSSurfaceKitUnsetPoints ()
 
NURBSSurfaceKitUnsetPriority ()
 
NURBSSurfaceKitUnsetTrims ()
 
NURBSSurfaceKitUnsetUCount ()
 
NURBSSurfaceKitUnsetUDegree ()
 
NURBSSurfaceKitUnsetUKnots ()
 
NURBSSurfaceKitUnsetUserData (intptr_t in_index)
 
NURBSSurfaceKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
NURBSSurfaceKitUnsetUserData (IntPtrTArray const &in_indices)
 
NURBSSurfaceKitUnsetVCount ()
 
NURBSSurfaceKitUnsetVDegree ()
 
NURBSSurfaceKitUnsetVKnots ()
 
NURBSSurfaceKitUnsetWeights ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
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 ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::NURBSSurfaceKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- 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 ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The NURBSSurfaceKit class is a user space object. It is a kit analog to a NURBSSurfaceKey.

Constructor & Destructor Documentation

◆ NURBSSurfaceKit() [1/3]

HPS::NURBSSurfaceKit::NURBSSurfaceKit ( )

The default constructor creates an empty NURBSSurfaceKit object.

◆ NURBSSurfaceKit() [2/3]

HPS::NURBSSurfaceKit::NURBSSurfaceKit ( NURBSSurfaceKit const &  in_kit)

The copy constructor creates a new NURBSSurfaceKit object that contains the same settings as the source NURBSSurfaceKit.

Parameters
in_kitThe source NURBSSurfaceKit to copy.

◆ NURBSSurfaceKit() [3/3]

HPS::NURBSSurfaceKit::NURBSSurfaceKit ( NURBSSurfaceKit &&  in_that)

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

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

Member Function Documentation

◆ Consume()

void HPS::NURBSSurfaceKit::Consume ( NURBSSurfaceKit in_kit)

Copies the source NURBSSurfaceKit into this NURBSSurfaceKit and resets the source kit.

Parameters
in_kitThe source NURBSSurfaceKit to consume.

◆ EditPointsByDeletion()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditPointsByDeletion ( size_t  in_offset,
size_t  in_count 
)

Removes points from the control point list for this NURBSSurfaceKit.

Parameters
in_offsetThe offset into the control point list for the NURBSSurfaceKit at which to start removing points. This value must be such that in_offset<control_point_count for deletion to succeed.
in_countThe number of points to delete from the control point list for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=control_point_count for the deletion to succeed.
Returns
A reference to this NURBSSurfaceKit.

◆ EditPointsByInsertion() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditPointsByInsertion ( size_t  in_offset,
size_t  in_count,
Point const  in_points[] 
)

Adds points to the control point list for this NURBSSurfaceKit.

Parameters
in_offsetThe offset into the control point list for the NURBSSurfaceKit at which to insert points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_countSize of the following array.
in_pointsThe points to insert into the control point list at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditPointsByInsertion() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditPointsByInsertion ( size_t  in_offset,
PointArray const &  in_points 
)

Adds points to the control point list for this NURBSSurfaceKit.

Parameters
in_offsetThe offset into the control point list for the NURBSSurfaceKit at which to insert points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_pointsThe points to insert into the control point list at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditPointsByReplacement() [1/2]

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

Replaces control points for this NURBSSurfaceKit.

Parameters
in_offsetThe offset into the control point list for the NURBSSurfaceKit at which to replace points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_countSize of the following array. This value must be 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 NURBSSurfaceKit.

◆ EditPointsByReplacement() [2/2]

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

Replaces control points for this NURBSSurfaceKit.

Parameters
in_offsetThe offset into the control point list for the NURBSSurfaceKit at which to replace points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_pointsThe points to use to replace those in the control point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=control_point_count for the replacement to succeed.
Returns
A reference to this NURBSSurfaceKit.

◆ EditUKnotsByDeletion()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditUKnotsByDeletion ( size_t  in_offset,
size_t  in_count 
)

Removes knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the U direction for the NURBSSurfaceKit at which to start removing knots. This value must be such that in_offset<u_count+u_degree+1 for deletion to succeed.
in_countThe number of knots in the U direction to delete for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=u_count+u_degree+1 for the deletion to succeed.
Returns
A reference to this NURBSSurfaceKit.

◆ EditUKnotsByInsertion() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditUKnotsByInsertion ( size_t  in_offset,
size_t  in_count,
float const  in_knots[] 
)

Adds knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the U direction for the NURBSSurfaceKit at which to insert knots. This value must be such that in_offset<u_count+u_degree+1 for insertion to succeed.
in_countSize of the following array.
in_knotsThe knots to insert in the U direction at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditUKnotsByInsertion() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditUKnotsByInsertion ( size_t  in_offset,
FloatArray const &  in_knots 
)

Adds knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the U direction for the NURBSSurfaceKit at which to insert knots. This value must be such that in_offset<u_count+u_degree+1 for insertion to succeed.
in_knotsThe knots to insert in the U direction at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditUKnotsByReplacement() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditUKnotsByReplacement ( size_t  in_offset,
size_t  in_count,
float const  in_knots[] 
)

Replaces knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the U direction for the NURBSSurfaceKit at which to replace knots. This value must be such that in_offset<u_count+u_degree+1 for the replacement to succeed.
in_countSize of the following array. This value must be such that in_offset+in_count<=u_count+u_degree+1 for the replacement to succeed.
in_knotsThe knots to use to replace those in the U direction at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditUKnotsByReplacement() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditUKnotsByReplacement ( size_t  in_offset,
FloatArray const &  in_knots 
)

Replaces knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the U direction for the NURBSSurfaceKit at which to replace knots. This value must be such that in_offset<u_count+u_degree+1 for the replacement to succeed.
in_knotsThe knots to use to replace those in the U direction 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.
Returns
A reference to this NURBSSurfaceKit.

◆ EditVKnotsByDeletion()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditVKnotsByDeletion ( size_t  in_offset,
size_t  in_count 
)

Removes knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the V direction for the NURBSSurfaceKit at which to start removing knots. This value must be such that in_offset<v_count+v_degree+1 for deletion to succeed.
in_countThe number of knots in the V direction to delete for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=v_count+v_degree+1 for the deletion to succeed.
Returns
A reference to this NURBSSurfaceKit.

◆ EditVKnotsByInsertion() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditVKnotsByInsertion ( size_t  in_offset,
size_t  in_count,
float const  in_knots[] 
)

Adds knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the V direction for the NURBSSurfaceKit at which to insert knots. This value must be such that in_offset<v_count+v_degree+1 for insertion to succeed.
in_countSize of the following array.
in_knotsThe knots to insert in the V direction at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditVKnotsByInsertion() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditVKnotsByInsertion ( size_t  in_offset,
FloatArray const &  in_knots 
)

Adds knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the V direction for the NURBSSurfaceKit at which to insert knots. This value must be such that in_offset<v_count+v_degree+1 for insertion to succeed.
in_knotsThe knots to insert in the V direction at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditVKnotsByReplacement() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditVKnotsByReplacement ( size_t  in_offset,
size_t  in_count,
float const  in_knots[] 
)

Replaces knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the V direction for the NURBSSurfaceKit at which to replace knots. This value must be such that in_offset<v_count+v_degree+1 for the replacement to succeed.
in_countSize of the following array. This value must be such that in_offset+in_count<=v_count+v_degree+1 for the replacement to succeed.
in_knotsThe knots to use to replace those in the V direction at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditVKnotsByReplacement() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditVKnotsByReplacement ( size_t  in_offset,
FloatArray const &  in_knots 
)

Replaces knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Parameters
in_offsetThe offset into the knots in the V direction for the NURBSSurfaceKit at which to replace knots. This value must be such that in_offset<v_count+v_degree+1 for the replacement to succeed.
in_knotsThe knots to use to replace those in the V direction 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.
Returns
A reference to this NURBSSurfaceKit.

◆ EditWeightsByDeletion()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditWeightsByDeletion ( size_t  in_offset,
size_t  in_count 
)

Removes weights from the control point weight list for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Parameters
in_offsetThe offset into the control point weight list for the NURBSSurfaceKit at which to start removing weights. This value must be such that in_offset<control_point_count for deletion to succeed.
in_countThe number of weights to delete from the control point weight list for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=control_point_count for the deletion to succeed.
Returns
A reference to this NURBSSurfaceKit.

◆ EditWeightsByInsertion() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditWeightsByInsertion ( size_t  in_offset,
size_t  in_count,
float const  in_weights[] 
)

Adds weights to the control point weight list for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Parameters
in_offsetThe offset into the control point weight list for the NURBSSurfaceKit at which to insert weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_countSize of the following array.
in_weightsThe weights to insert into the control point weight list at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditWeightsByInsertion() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::EditWeightsByInsertion ( size_t  in_offset,
FloatArray const &  in_weights 
)

Adds weights to the control point weight list for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Parameters
in_offsetThe offset into the control point weight list for the NURBSSurfaceKit at which to insert weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_weightsThe weights to insert into the control point weight list at the specified offset.
Returns
A reference to this NURBSSurfaceKit.

◆ EditWeightsByReplacement() [1/2]

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

Replaces control point weights for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Parameters
in_offsetThe offset into the control point weight list for the NURBSSurfaceKit at which to replace weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_countSize of the following array. This value must be 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 NURBSSurfaceKit.

◆ EditWeightsByReplacement() [2/2]

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

Replaces control point weights for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Parameters
in_offsetThe offset into the control point weight list for the NURBSSurfaceKit at which to replace weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_weightsThe weights to use to replace those in the control point weight list at the specified offset. This size of the array must be such that in_offset+in_weights.size()<=control_point_count for the replacement to succeed.
Returns
A reference to this NURBSSurfaceKit.

◆ Empty()

bool HPS::NURBSSurfaceKit::Empty ( ) const
virtual

Indicates whether this NURBSSurfaceKit has any values set on it.

Returns
true if no values are set on this NURBSSurfaceKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::NURBSSurfaceKit::Equals ( NURBSSurfaceKit const &  in_kit) const

Check if the source NURBSSurfaceKit is equivalent to this NURBSSurfaceKit.

Parameters
in_kitThe source NURBSSurfaceKit to compare to this NURBSSurfaceKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPointCount()

size_t HPS::NURBSSurfaceKit::GetPointCount ( ) const

Retrieves the number of points in this NURBS surface.

Returns
The number of points in this NURBS surface.

◆ ObjectType()

HPS::Type HPS::NURBSSurfaceKit::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::Kit.

◆ operator!=()

bool HPS::NURBSSurfaceKit::operator!= ( NURBSSurfaceKit const &  in_kit) const

Check if the source NURBSSurfaceKit is not equivalent to this NURBSSurfaceKit.

Parameters
in_kitThe source NURBSSurfaceKit to compare to this NURBSSurfaceKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

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

◆ operator=() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::operator= ( NURBSSurfaceKit const &  in_kit)

Copies the source NURBSSurfaceKit into this NURBSSurfaceKit.

Parameters
in_kitThe source NURBSSurfaceKit to copy.
Returns
A reference to this NURBSSurfaceKit.

◆ operator==()

bool HPS::NURBSSurfaceKit::operator== ( NURBSSurfaceKit const &  in_kit) const

Check if the source NURBSSurfaceKit is equivalent to this NURBSSurfaceKit.

Parameters
in_kitThe source NURBSSurfaceKit to compare to this NURBSSurfaceKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::NURBSSurfaceKit::Set ( NURBSSurfaceKit const &  in_kit)

Copies the source NURBSSurfaceKit into this NURBSSurfaceKit.

Parameters
in_kitThe source NURBSSurfaceKit to copy.

◆ SetPoints() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetPoints ( PointArray const &  in_points)

Sets the control points for the NURBSSurfaceKit.

Parameters
in_pointsThe control points for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetPoints() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetPoints ( size_t  in_count,
Point const  in_points[] 
)

Sets the control points for the NURBSSurfaceKit.

Parameters
in_countSize of the following array.
in_pointsThe control points for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetPriority()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetPriority ( int  in_priority)

Assigns a specific drawing priority value to the NURBSSurfaceKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit::SetPriority()
SubwindowKit::SetRenderingAlgorithm()

◆ SetTrim()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetTrim ( TrimKit const &  in_trim)

Sets the trim for the NURBSSurfaceKit.

Parameters
in_trimThe trim for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetTrims() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetTrims ( TrimKitArray const &  in_trims)

Sets the trims for the NURBSSurfaceKit.

Parameters
in_trimsThe trims for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetTrims() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetTrims ( size_t  in_count,
TrimKit const  in_trims[] 
)

Sets the trims for the NURBSSurfaceKit.

Parameters
in_countSize of the following array.
in_trimsThe trims for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetUCount()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUCount ( size_t  in_count)

Sets the number of control points in the U direction for the NURBSSurfaceKit.

Parameters
in_countThe number of control points in the U direction for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetUDegree()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUDegree ( size_t  in_degree)

Sets degree of the NURBSSurfaceKit in the U direction.

Parameters
in_degreeThe degree of the NURBSSurfaceKit in the U direction.
Returns
A reference to this NURBSSurfaceKit.

◆ SetUKnots() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUKnots ( FloatArray const &  in_knots)

Sets the knots in the U direction for the NURBSSurfaceKit. If no knots are set when this kit is used to insert a NURBS surface, default knots of increasing value in the range [0,u_count+u_degree+1) will be used.

Parameters
in_knotsThe knots in the U direction for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetUKnots() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUKnots ( size_t  in_count,
float const  in_knots[] 
)

Sets the knots in the U direction for the NURBSSurfaceKit. If no knots are set when this kit is used to insert a NURBS surface, default knots of increasing value in the range [0,u_count+u_degree+1) will be used.

Parameters
in_countSize of the following array.
in_knotsThe knots in the U direction for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetUserData() [1/3]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUserData ( intptr_t  in_index,
size_t  in_bytes,
byte const  in_data[] 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUserData ( intptr_t  in_index,
ByteArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetUserData ( IntPtrTArray const &  in_indices,
ByteArrayArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ SetVCount()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetVCount ( size_t  in_count)

Sets the number of control points in the V direction for the NURBSSurfaceKit.

Parameters
in_countThe number of control points in the V direction for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetVDegree()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetVDegree ( size_t  in_degree)

Sets degree of the NURBSSurfaceKit in the V direction.

Parameters
in_degreeThe degree of the NURBSSurfaceKit in the V direction.
Returns
A reference to this NURBSSurfaceKit.

◆ SetVKnots() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetVKnots ( FloatArray const &  in_knots)

Sets the knots in the V direction for the NURBSSurfaceKit. If no knots are set when this kit is used to insert a NURBS surface, default knots of increasing value in the range [0,v_count+v_degree+1) will be used.

Parameters
in_knotsThe knots in the V direction for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetVKnots() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetVKnots ( size_t  in_count,
float const  in_knots[] 
)

Sets the knots in the V direction for the NURBSSurfaceKit. If no knots are set when this kit is used to insert a NURBS surface, default knots of increasing value in the range [0,v_count+v_degree+1) will be used.

Parameters
in_countSize of the following array.
in_knotsThe knots in the V direction for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetWeights() [1/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetWeights ( FloatArray const &  in_weights)

Sets the control point weights for the NURBSSurfaceKit. If no weights are set when this kit is used to insert a NURBS surface, default weights of 1.0f per control point will be used.

Parameters
in_weightsThe control point weights for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ SetWeights() [2/2]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::SetWeights ( size_t  in_count,
float const  in_weights[] 
)

Sets the control point weights for the NURBSSurfaceKit. If no weights are set when this kit is used to insert a NURBS surface, default weights of 1.0f per control point will be used.

Parameters
in_countSize of the following array.
in_weightsThe control point weights for the NURBSSurfaceKit.
Returns
A reference to this NURBSSurfaceKit.

◆ Show()

void HPS::NURBSSurfaceKit::Show ( NURBSSurfaceKit out_kit) const

Copies this NURBSSurfaceKit into the given NURBSSurfaceKit.

Parameters
out_kitThe NURBSSurfaceKit to populate with the contents of this NURBSSurfaceKit.

◆ ShowPoints()

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

Shows the control points for this NURBSSurfaceKit.

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

◆ ShowPointsByList() [1/2]

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

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

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

◆ ShowPointsByList() [2/2]

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowPriority()

bool HPS::NURBSSurfaceKit::ShowPriority ( int &  out_priority) const

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowTrims()

bool HPS::NURBSSurfaceKit::ShowTrims ( TrimKitArray out_trims) const

Shows the trims for this NURBSSurfaceKit.

Parameters
out_trimsThe trims for this NURBSSurfaceKit.
Returns
true if trims were set, false otherwise.

◆ ShowUCount()

bool HPS::NURBSSurfaceKit::ShowUCount ( size_t &  out_count) const

Shows the number of control points in the U direction for this NURBSSurfaceKit.

Parameters
out_countThe number of control points in the U direction for this NURBSSurfaceKit.
Returns
true if such a count was set, false otherwise.

◆ ShowUDegree()

bool HPS::NURBSSurfaceKit::ShowUDegree ( size_t &  out_degree) const

Shows the degree of this NURBSSurfaceKit in the U direction.

Parameters
out_degreeThe degree of this NURBSSurfaceKit in the U direction.
Returns
true if such a degree was set, false otherwise.

◆ ShowUKnots()

bool HPS::NURBSSurfaceKit::ShowUKnots ( FloatArray out_knots) const

Shows the knots in the U direction for this NURBSSurfaceKit.

Parameters
out_knotsThe knots in the U direction for this NURBSSurfaceKit.
Returns
true if these knots were set, false otherwise.

◆ ShowUserData() [1/2]

bool HPS::NURBSSurfaceKit::ShowUserData ( intptr_t  in_index,
ByteArray out_data 
) const

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS::NURBSSurfaceKit::ShowUserData ( IntPtrTArray out_indices,
ByteArrayArray out_data 
) const

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

size_t HPS::NURBSSurfaceKit::ShowUserDataCount ( ) const

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS::NURBSSurfaceKit::ShowUserDataIndices ( IntPtrTArray out_indices) const

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ ShowVCount()

bool HPS::NURBSSurfaceKit::ShowVCount ( size_t &  out_count) const

Shows the number of control points in the V direction for this NURBSSurfaceKit.

Parameters
out_countThe number of control points in the V direction for this NURBSSurfaceKit.
Returns
true if such a count was set, false otherwise.

◆ ShowVDegree()

bool HPS::NURBSSurfaceKit::ShowVDegree ( size_t &  out_degree) const

Shows the degree of this NURBSSurfaceKit in the V direction.

Parameters
out_degreeThe degree of this NURBSSurfaceKit in the V direction.
Returns
true if such a degree was set, false otherwise.

◆ ShowVKnots()

bool HPS::NURBSSurfaceKit::ShowVKnots ( FloatArray out_knots) const

Shows the knots in the V direction for this NURBSSurfaceKit.

Parameters
out_knotsThe knots in the V direction for this NURBSSurfaceKit.
Returns
true if these knots were set, false otherwise.

◆ ShowWeights()

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

Shows the control point weights for this NURBSSurfaceKit.

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

◆ UnsetAllUserData()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetEverything ( )

Removes all settings from the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetPoints()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetPoints ( )

Removes the control points for the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetPriority()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetTrims()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetTrims ( )

Removes the trims from the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetUCount()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetUCount ( )

Removes the setting for the number of points in the U direction for the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetUDegree()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetUDegree ( )

Removes the setting for the degree of the NURBSSurfaceKit in the U direction.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetUKnots()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetUKnots ( )

Removes the knots in the U direction for the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetUserData() [1/3]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetUserData ( intptr_t  in_index)

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/3]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetUserData ( size_t  in_count,
intptr_t const  in_indices[] 
)

Removes the user data at the given indices from this kit.

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [3/3]

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetUserData ( IntPtrTArray const &  in_indices)

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetVCount()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetVCount ( )

Removes the setting for the number of points in the V direction for the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetVDegree()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetVDegree ( )

Removes the setting for the degree of the NURBSSurfaceKit in the V direction.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetVKnots()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetVKnots ( )

Removes the knots in the V direction for the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

◆ UnsetWeights()

NURBSSurfaceKit& HPS::NURBSSurfaceKit::UnsetWeights ( )

Removes the control point weights for the NURBSSurfaceKit.

Returns
A reference to this NURBSSurfaceKit.

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