The NURBSCurveKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::NURBSCurveKit:

Collaboration diagram for HPS::NURBSCurveKit:

Public Member Functions
	NURBSCurveKit ()
	The default constructor creates an empty NURBSCurveKit object. More...

	NURBSCurveKit (NURBSCurveKit const &in_kit)
	The copy constructor creates a new NURBSCurveKit object that contains the same settings as the source NURBSCurveKit. More...

	NURBSCurveKit (NURBSCurveKit &&in_that)
	The move constructor creates a NURBSCurveKit by transferring the underlying impl of the rvalue reference to this NURBSCurveKit thereby avoiding a copy and allocation. More...

NURBSCurveKit &	operator= (NURBSCurveKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSCurveKit thereby avoiding a copy. More...

virtual	~NURBSCurveKit ()

HPS::Type	ObjectType () const

void	Consume (NURBSCurveKit &in_kit)
	Copies the source NURBSCurveKit into this NURBSCurveKit and resets the source kit. More...

void	Set (NURBSCurveKit const &in_kit)
	Copies the source NURBSCurveKit into this NURBSCurveKit. More...

void	Show (NURBSCurveKit &out_kit) const
	Copies this NURBSCurveKit into the given NURBSCurveKit. More...

NURBSCurveKit &	operator= (NURBSCurveKit const &in_kit)
	Copies the source NURBSCurveKit into this NURBSCurveKit. More...

bool	Empty () const
	Indicates whether this NURBSCurveKit has any values set on it. More...

bool	Equals (NURBSCurveKit const &in_kit) const
	Check if the source NURBSCurveKit is equivalent to this NURBSCurveKit. More...

bool	operator== (NURBSCurveKit const &in_kit) const
	Check if the source NURBSCurveKit is equivalent to this NURBSCurveKit. More...

bool	operator!= (NURBSCurveKit const &in_kit) const
	Check if the source NURBSCurveKit is not equivalent to this NURBSCurveKit. More...

size_t	GetPointCount () const
	Retrieves the number of points in this NURBS curve. More...

NURBSCurveKit &	SetPriority (int in_priority)
	Assigns a specific drawing priority value to the NURBSCurveKit. More...

NURBSCurveKit &	UnsetPriority ()
	Removes a drawing priority setting. More...

bool	ShowPriority (int &out_priority) const
	Shows the drawing priority. More...

NURBSCurveKit &	SetDegree (size_t in_degree)
	Sets the degree of the NURBSCurveKit. More...

NURBSCurveKit &	SetPoints (PointArray const &in_points)
	Sets the control points for the NURBSCurveKit. More...

NURBSCurveKit &	SetPoints (size_t in_count, Point const in_points [])
	Sets the control points for the NURBSCurveKit. More...

NURBSCurveKit &	SetWeights (FloatArray const &in_weights)
	Sets the control point weights for the NURBSCurveKit. More...

NURBSCurveKit &	SetWeights (size_t in_count, float const in_weights [])
	Sets the control point weights for the NURBSCurveKit. More...

NURBSCurveKit &	SetKnots (FloatArray const &in_knots)
	Sets the knots for the NURBSCurveKit. More...

NURBSCurveKit &	SetKnots (size_t in_count, float const in_knots [])
	Sets the knots for the NURBSCurveKit. More...

NURBSCurveKit &	SetParameters (float in_start, float in_end)
	Sets the normalized start and end parameters for the NURBSCurveKit. More...

NURBSCurveKit &	UnsetDegree ()
	Removes the setting for the degree of the NURBSCurveKit. More...

NURBSCurveKit &	UnsetPoints ()
	Removes the control points for the NURBSCurveKit. More...

NURBSCurveKit &	UnsetWeights ()
	Removes the control point weights for the NURBSCurveKit. More...

NURBSCurveKit &	UnsetKnots ()
	Removes the knots for the NURBSCurveKit. More...

NURBSCurveKit &	UnsetParameters ()
	Removes the normalized start and end parameters for the NURBSCurveKit. More...

NURBSCurveKit &	UnsetEverything ()
	Removes all settings from the NURBSCurveKit. More...

bool	ShowDegree (size_t &out_degree) const
	Shows the degree of this NURBSCurveKit. More...

bool	ShowPoints (PointArray &out_points) const
	Shows the control points for this NURBSCurveKit. More...

bool	ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
	Show a subset of the points for this NURBSCurveKit by range. More...

bool	ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
	Show a subset of the points for this NURBSCurveKit by list. More...

bool	ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const
	Show a subset of the points for this NURBSCurveKit by list. More...

bool	ShowWeights (FloatArray &out_weights) const
	Shows the control point weights for this NURBSCurveKit. More...

bool	ShowKnots (FloatArray &out_knots) const
	Shows the knots for this NURBSCurveKit. More...

bool	ShowParameters (float &out_start, float &out_end) const
	Shows the normalized start and end parameters for this NURBSCurveKit. More...

NURBSCurveKit &	EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
	Adds points to the control point list for this NURBSCurveKit. More...

NURBSCurveKit &	EditPointsByInsertion (size_t in_offset, PointArray const &in_points)
	Adds points to the control point list for this NURBSCurveKit. More...

NURBSCurveKit &	EditPointsByDeletion (size_t in_offset, size_t in_count)
	Removes points from the control point list for this NURBSCurveKit. More...

NURBSCurveKit &	EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
	Replaces control points for this NURBSCurveKit. More...

NURBSCurveKit &	EditPointsByReplacement (size_t in_offset, PointArray const &in_points)
	Replaces control points for this NURBSCurveKit. More...

NURBSCurveKit &	EditWeightsByInsertion (size_t in_offset, size_t in_count, float const in_weights[])
	Adds weights to the control point weight list for this NURBSCurveKit. More...

NURBSCurveKit &	EditWeightsByInsertion (size_t in_offset, FloatArray const &in_weights)
	Adds weights to the control point weight list for this NURBSCurveKit. More...

NURBSCurveKit &	EditWeightsByDeletion (size_t in_offset, size_t in_count)
	Removes weights from the control point weight list for this NURBSCurveKit. More...

NURBSCurveKit &	EditWeightsByReplacement (size_t in_offset, size_t in_count, float const in_weights[])
	Replaces control point weights for this NURBSCurveKit. More...

NURBSCurveKit &	EditWeightsByReplacement (size_t in_offset, FloatArray const &in_weights)
	Replaces control point weights for this NURBSCurveKit. More...

NURBSCurveKit &	EditKnotsByInsertion (size_t in_offset, size_t in_count, float const in_knots[])
	Adds knots for this NURBSCurveKit. More...

NURBSCurveKit &	EditKnotsByInsertion (size_t in_offset, FloatArray const &in_knots)
	Adds knots for this NURBSCurveKit. More...

NURBSCurveKit &	EditKnotsByDeletion (size_t in_offset, size_t in_count)
	Removes knots for this NURBSCurveKit. More...

NURBSCurveKit &	EditKnotsByReplacement (size_t in_offset, size_t in_count, float const in_knots[])
	Replaces knots for this NURBSCurveKit. More...

NURBSCurveKit &	EditKnotsByReplacement (size_t in_offset, FloatArray const &in_knots)
	Replaces knots for this NURBSCurveKit. More...

NURBSCurveKit &	SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
	Sets user data on this kit. More...

NURBSCurveKit &	SetUserData (intptr_t in_index, ByteArray const &in_data)
	Sets user data on this kit. More...

NURBSCurveKit &	SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
	Sets user data on this kit. More...

NURBSCurveKit &	UnsetUserData (intptr_t in_index)
	Removes the user data at the given index from this kit. More...

NURBSCurveKit &	UnsetUserData (size_t in_count, intptr_t const in_indices[])
	Removes the user data at the given indices from this kit. More...

NURBSCurveKit &	UnsetUserData (IntPtrTArray const &in_indices)
	Removes the user data at the given indices from this kit. More...

NURBSCurveKit &	UnsetAllUserData ()
	Removes all user data from this kit. More...

size_t	ShowUserDataCount () const
	Get the number of user data indices set on this kit. More...

bool	ShowUserDataIndices (IntPtrTArray &out_indices) const
	Shows the indices of all user data set on this kit. More...

bool	ShowUserData (intptr_t in_index, ByteArray &out_data) const
	Shows the user data at a given index for this kit. More...

bool	ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
	Shows all user data for this kit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::NURBSCurveKit

Detailed Description

The NURBSCurveKit class is a user space object.

It is a kit analog to a NURBSCurveKey.

Constructor & Destructor Documentation

◆ NURBSCurveKit() [1/3]

HPS::NURBSCurveKit::NURBSCurveKit ( )

The default constructor creates an empty NURBSCurveKit object.

◆ NURBSCurveKit() [2/3]

HPS::NURBSCurveKit::NURBSCurveKit ( NURBSCurveKit const & in_kit )

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

Parameters

in_kit The source NURBSCurveKit to copy.

◆ NURBSCurveKit() [3/3]

HPS::NURBSCurveKit::NURBSCurveKit ( NURBSCurveKit && in_that )

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

Parameters

in_that An rvalue reference to a NURBSCurveKit to take the impl from.

◆ ~NURBSCurveKit()

virtual HPS::NURBSCurveKit::~NURBSCurveKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Consume()

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

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

Parameters

in_kit The source NURBSCurveKit to consume.

◆ EditKnotsByDeletion()

NURBSCurveKit& HPS::NURBSCurveKit::EditKnotsByDeletion	(	size_t	in_offset,
		size_t	in_count
	)

Removes knots for this NURBSCurveKit.

This will allow modification of the default knots if no explicit knots are set if possible.

Parameters

in_offset	The offset into the knots for the NURBSCurveKit at which to start removing knots. This value must be such that in_offset<control_point_count+degree+1 for deletion to succeed.
in_count	The number of knots to delete for the NURBSCurveKit. This value must be such that in_offset+in_count<=control_point_count+degree+1 for the deletion to succeed.

Returns: A reference to this NURBSCurveKit.

◆ EditKnotsByInsertion() [1/2]

NURBSCurveKit& HPS::NURBSCurveKit::EditKnotsByInsertion	(	size_t	in_offset,
		size_t	in_count,
		float const	in_knots[]
	)

Adds knots for this NURBSCurveKit.

This will allow modification of the default knots if no explicit knots are set if possible.

Parameters

in_offset	The offset into the knots the NURBSCurveKit at which to insert knots. This value must be such that in_offset<control_point_count+degree+1 for insertion to succeed.
in_count	Size of the following array.
in_knots	The knots to insert at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditKnotsByInsertion() [2/2]

NURBSCurveKit& HPS::NURBSCurveKit::EditKnotsByInsertion	(	size_t	in_offset,
		FloatArray const &	in_knots
	)

Adds knots for this NURBSCurveKit.

This will allow modification of the default knots if no explicit knots are set if possible.

Parameters

in_offset	The offset into the knots the NURBSCurveKit at which to insert knots. This value must be such that in_offset<control_point_count+degree+1 for insertion to succeed.
in_knots	The knots to insert at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditKnotsByReplacement() [1/2]

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

Replaces knots for this NURBSCurveKit.

This will allow modification of the default knots if no explicit knots are set if possible.

Parameters

in_offset	The offset into the knots for the NURBSCurveKit at which to replace knots. This value must be such that in_offset<control_point_count+degree+1 for the replacement to succeed.
in_count	Size of the following array. This value must be such that in_offset+in_count<=control_point_count+degree+1 for the replacement to succeed.
in_knots	The knots to use to replace those at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditKnotsByReplacement() [2/2]

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

Replaces knots for this NURBSCurveKit.

This will allow modification of the default knots if no explicit knots are set if possible.

Parameters

in_offset	The offset into the knots for the NURBSCurveKit at which to replace knots. This value must be such that in_offset<control_point_count+degree+1 for the replacement to succeed.
in_knots	The 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 NURBSCurveKit.

◆ EditPointsByDeletion()

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

Removes points from the control point list for this NURBSCurveKit.

Parameters

in_offset	The offset into the control point list for the NURBSCurveKit at which to start removing points. This value must be such that in_offset<control_point_count for deletion to succeed.
in_count	The number of points to delete from the control point list for the NURBSCurveKit. This value must be such that in_offset+in_count<=control_point_count for the deletion to succeed.

Returns: A reference to this NURBSCurveKit.

◆ EditPointsByInsertion() [1/2]

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

Adds points to the control point list for this NURBSCurveKit.

Parameters

in_offset	The offset into the control point list for the NURBSCurveKit at which to insert points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_count	Size of the following array.
in_points	The points to insert into the control point list at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditPointsByInsertion() [2/2]

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

Adds points to the control point list for this NURBSCurveKit.

Parameters

in_offset	The offset into the control point list for the NURBSCurveKit at which to insert points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_points	The points to insert into the control point list at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditPointsByReplacement() [1/2]

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

Replaces control points for this NURBSCurveKit.

Parameters

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

Returns: A reference to this NURBSCurveKit.

◆ EditPointsByReplacement() [2/2]

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

Replaces control points for this NURBSCurveKit.

Parameters

in_offset	The offset into the control point list for the NURBSCurveKit at which to replace points. This value must be such that in_offset<control_point_count for insertion to succeed.
in_points	The 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 NURBSCurveKit.

◆ EditWeightsByDeletion()

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

Removes weights from the control point weight list for this NURBSCurveKit.

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

Parameters

in_offset	The offset into the control point weight list for the NURBSCurveKit at which to start removing weights. This value must be such that in_offset<control_point_count for deletion to succeed.
in_count	The number of weights to delete from the control point weight list for the NURBSCurveKit. This value must be such that in_offset+in_count<=weight_count for the deletion to succeed.

Returns: A reference to this NURBSCurveKit.

◆ EditWeightsByInsertion() [1/2]

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

Adds weights to the control point weight list for this NURBSCurveKit.

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

Parameters

in_offset	The offset into the control point weight list for the NURBSCurveKit at which to insert weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_count	Size of the following array.
in_weights	The weights to insert into the control point weight list at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditWeightsByInsertion() [2/2]

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

Adds weights to the control point weight list for this NURBSCurveKit.

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

Parameters

in_offset	The offset into the control point weight list for the NURBSCurveKit at which to insert weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_weights	The weights to insert into the control point weight list at the specified offset.

Returns: A reference to this NURBSCurveKit.

◆ EditWeightsByReplacement() [1/2]

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

Replaces control point weights for this NURBSCurveKit.

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

Parameters

in_offset	The offset into the control point weight list for the NURBSCurveKit at which to replace weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_count	Size of the following array. This value must be such that in_offset+in_count<=weight_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.

Returns: A reference to this NURBSCurveKit.

◆ EditWeightsByReplacement() [2/2]

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

Replaces control point weights for this NURBSCurveKit.

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

Parameters

in_offset	The offset into the control point weight list for the NURBSCurveKit at which to replace weights. This value must be such that in_offset<control_point_count for insertion to succeed.
in_weights	The 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()<=weight_count for the replacement to succeed.

Returns: A reference to this NURBSCurveKit.

◆ Empty()

bool HPS::NURBSCurveKit::Empty ( ) const

virtual

Indicates whether this NURBSCurveKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source NURBSCurveKit is equivalent to this NURBSCurveKit.

Parameters

in_kit The source NURBSCurveKit to compare to this NURBSCurveKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ GetPointCount()

size_t HPS::NURBSCurveKit::GetPointCount ( ) const

Retrieves the number of points in this NURBS curve.

Returns: The number of points in this NURBS curve.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::NURBSCurveKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source NURBSCurveKit to compare to this NURBSCurveKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a NURBSCurveKit to take the impl from.

Returns: A reference to this NURBSCurveKit.

◆ operator=() [2/2]

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

Copies the source NURBSCurveKit into this NURBSCurveKit.

Parameters

in_kit The source NURBSCurveKit to copy.

Returns: A reference to this NURBSCurveKit.

◆ operator==()

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

Check if the source NURBSCurveKit is equivalent to this NURBSCurveKit.

Parameters

in_kit The source NURBSCurveKit to compare to this NURBSCurveKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source NURBSCurveKit into this NURBSCurveKit.

Parameters

in_kit The source NURBSCurveKit to copy.

◆ SetDegree()

NURBSCurveKit& HPS::NURBSCurveKit::SetDegree ( size_t in_degree )

Sets the degree of the NURBSCurveKit.

Parameters

in_degree The degree of the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetKnots() [1/2]

NURBSCurveKit& HPS::NURBSCurveKit::SetKnots ( FloatArray const & in_knots )

Sets the knots for the NURBSCurveKit.

Parameters

in_knots The knots for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetKnots() [2/2]

NURBSCurveKit& HPS::NURBSCurveKit::SetKnots	(	size_t	in_count,
		float const	in_knots[]
	)

Sets the knots for the NURBSCurveKit.

Parameters

in_count	Size of the following array.
in_knots	The knots for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetParameters()

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

Sets the normalized start and end parameters for the NURBSCurveKit.

Parameters

in_start	The noramlized start parameter for the NURBSCurveKit.
in_end	The noramlized end parameter for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetPoints() [1/2]

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

Sets the control points for the NURBSCurveKit.

Parameters

in_points The control points for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetPoints() [2/2]

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

Sets the control points for the NURBSCurveKit.

Parameters

in_count	Size of the following array.
in_points	The control points for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the NURBSCurveKit.

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_priority The 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()

◆ SetUserData() [1/3]

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

Sets user data on this kit.

Parameters

in_index	The index of the user data to set.
in_bytes	The number of bytes of user data to set.
in_data	The bytes of user data to set.

Returns: A reference to this kit.

◆ SetUserData() [2/3]

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

Sets user data on this kit.

Parameters

in_index	The index of the user data to set.
in_data	The bytes of user data to set.

Returns: A reference to this kit.

◆ SetUserData() [3/3]

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

Sets user data on this kit.

Parameters

in_indices	An array of user data indices to set.
in_data	An array of bytes of user data to set.

Returns: A reference to this kit.

◆ SetWeights() [1/2]

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

Sets the control point weights for the NURBSCurveKit.

Parameters

in_weights The control point weights for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ SetWeights() [2/2]

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

Sets the control point weights for the NURBSCurveKit.

Parameters

in_count	Size of the following array.
in_weights	The control point weights for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ Show()

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

Copies this NURBSCurveKit into the given NURBSCurveKit.

Parameters

out_kit The NURBSCurveKit to populate with the contents of this NURBSCurveKit.

◆ ShowDegree()

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

Shows the degree of this NURBSCurveKit.

Parameters

out_degree The degree of this NURBSCurveKit.

Returns: true if a degree was set, false otherwise.

◆ ShowKnots()

bool HPS::NURBSCurveKit::ShowKnots ( FloatArray & out_knots ) const

Shows the knots for this NURBSCurveKit.

Parameters

out_knots The knots for this NURBSCurveKit.

Returns: true if knots were set, false otherwise.

◆ ShowParameters()

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

Shows the normalized start and end parameters for this NURBSCurveKit.

Parameters

out_start	The normalized start parameter for this NURBSCurveKit.
out_end	The normalized end parameter for this NURBSCurveKit.

Returns: true if start and end parameters were set, false otherwise.

◆ ShowPoints()

bool HPS::NURBSCurveKit::ShowPoints ( PointArray & out_points ) const

Shows the control points for this NURBSCurveKit.

Parameters

out_points The control points for this NURBSCurveKit.

Returns: true if control points were set, false otherwise.

◆ ShowPointsByList() [1/2]

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

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

Parameters

in_indices	The list of point indices to show.
out_points	The requested points for this NURBSCurveKit.

Returns: true if all requested points were set, false otherwise.

◆ ShowPointsByList() [2/2]

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

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

Parameters

in_count	The number of points to show.
in_indices	The list of point indices to show.
out_points	The requested points for this NURBSCurveKit.

Returns: true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

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

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

Parameters

in_start_index	The first point to show.
in_count	The number of points to show.
out_points	The requested points for this NURBSCurveKit.

Returns: true if all requested points were set, false otherwise.

◆ ShowPriority()

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

Shows the drawing priority.

Parameters

out_priority The drawing priority, higher priority items are drawn on top of lower priority items.

Returns: true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

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

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

Parameters

in_index	The index of the user data to show.
out_data	The user data at the given index.

Returns: true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

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

Shows all user data for this kit.

Parameters

out_indices	An array of all user data indices set on this kit.
out_data	An 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::NURBSCurveKit::ShowUserDataCount ( ) const

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

◆ ShowUserDataIndices()

bool HPS::NURBSCurveKit::ShowUserDataIndices ( IntPtrTArray & out_indices ) const

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

Parameters

out_indices The user data indices set on this kit.

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

◆ ShowWeights()

bool HPS::NURBSCurveKit::ShowWeights ( FloatArray & out_weights ) const

Shows the control point weights for this NURBSCurveKit.

Parameters

out_weights The control point weights for this NURBSCurveKit.

Returns: true if control point weights were set, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetAllUserData()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns: A reference to this kit.

◆ UnsetDegree()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetDegree ( )

Removes the setting for the degree of the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ UnsetEverything()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetEverything ( )

Removes all settings from the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ UnsetKnots()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetKnots ( )

Removes the knots for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ UnsetParameters()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetParameters ( )

Removes the normalized start and end parameters for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ UnsetPoints()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetPoints ( )

Removes the control points for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

◆ UnsetPriority()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns: A reference to this object.

◆ UnsetUserData() [1/3]

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

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

Parameters

in_index The index of the user data to remove.

Returns: A reference to this kit.

◆ UnsetUserData() [2/3]

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

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

Parameters

in_count	The size of the following array.
in_indices	The indices of the user data to remove.

Returns: A reference to this kit.

◆ UnsetUserData() [3/3]

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

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

Parameters

in_indices The indices of the user data to remove.

Returns: A reference to this kit.

◆ UnsetWeights()

NURBSCurveKit& HPS::NURBSCurveKit::UnsetWeights ( )

Removes the control point weights for the NURBSCurveKit.

Returns: A reference to this NURBSCurveKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::NURBSCurveKit::staticType = HPS::Type::NURBSCurveKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NURBSCurveKit() [1/3]

◆ NURBSCurveKit() [2/3]

◆ NURBSCurveKit() [3/3]

◆ ~NURBSCurveKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ EditKnotsByDeletion()

◆ EditKnotsByInsertion() [1/2]

◆ EditKnotsByInsertion() [2/2]

◆ EditKnotsByReplacement() [1/2]

◆ EditKnotsByReplacement() [2/2]

◆ EditPointsByDeletion()

◆ EditPointsByInsertion() [1/2]

◆ EditPointsByInsertion() [2/2]

◆ EditPointsByReplacement() [1/2]

◆ EditPointsByReplacement() [2/2]

◆ EditWeightsByDeletion()

◆ EditWeightsByInsertion() [1/2]

◆ EditWeightsByInsertion() [2/2]

◆ EditWeightsByReplacement() [1/2]

◆ EditWeightsByReplacement() [2/2]

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ GetPointCount()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetDegree()

◆ SetKnots() [1/2]

◆ SetKnots() [2/2]

◆ SetParameters()

◆ SetPoints() [1/2]

◆ SetPoints() [2/2]

◆ SetPriority()

◆ SetUserData() [1/3]

◆ SetUserData() [2/3]

◆ SetUserData() [3/3]

◆ SetWeights() [1/2]

◆ SetWeights() [2/2]

◆ Show()

◆ ShowDegree()

◆ ShowKnots()

◆ ShowParameters()

◆ ShowPoints()

◆ ShowPointsByList() [1/2]

◆ ShowPointsByList() [2/2]

◆ ShowPointsByRange()

◆ ShowPriority()

◆ ShowUserData() [1/2]

◆ ShowUserData() [2/2]

◆ ShowUserDataCount()

◆ ShowUserDataIndices()

◆ ShowWeights()

◆ Type()

◆ UnsetAllUserData()

◆ UnsetDegree()

◆ UnsetEverything()

◆ UnsetKnots()

◆ UnsetParameters()

◆ UnsetPoints()

◆ UnsetPriority()

◆ UnsetUserData() [1/3]

◆ UnsetUserData() [2/3]

◆ UnsetUserData() [3/3]

◆ UnsetWeights()

Member Data Documentation

◆ staticType