Public Member Functions | List of all members
HPS::EdgeAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::EdgeAttributeControl:
HPS::Control HPS::Object

Public Member Functions

 EdgeAttributeControl (SegmentKey &in_seg)
 
 EdgeAttributeControl (EdgeAttributeControl const &in_that)
 
 EdgeAttributeControl (EdgeAttributeControl &&in_that)
 
EdgeAttributeControloperator= (EdgeAttributeControl &&in_that)
 
 ~EdgeAttributeControl ()
 
HPS::Type ObjectType () const
 
EdgeAttributeControloperator= (EdgeAttributeControl const &in_that)
 
EdgeAttributeControlSetPattern (char const *in_pattern_name)
 
EdgeAttributeControlSetWeight (float in_weight, Edge::SizeUnits in_units=Edge::SizeUnits::ScaleFactor)
 
EdgeAttributeControlUnsetPattern ()
 
EdgeAttributeControlUnsetWeight ()
 
EdgeAttributeControlUnsetEverything ()
 
bool ShowPattern (UTF8 &out_pattern_name) const
 
bool ShowWeight (float &out_weight, Edge::SizeUnits &out_units) const
 
- Public Member Functions inherited from HPS::Object
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::EdgeAttributeControl class is a smart pointer that is tied to a database object. Using this control, you can manipulate the various attributes associated with geometry edges. Edges are present on any piece of facetted geometry.

This table lists default values for the various segment attributes accessible from HPS::EdgeAttributeControl.

Constructor & Destructor Documentation

HPS::EdgeAttributeControl::EdgeAttributeControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

HPS::EdgeAttributeControl::EdgeAttributeControl ( EdgeAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

HPS::EdgeAttributeControl::EdgeAttributeControl ( EdgeAttributeControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to an EdgeAttributeControl to take the impl from.
HPS::EdgeAttributeControl::~EdgeAttributeControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

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

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS::Control.

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

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

Parameters
in_thatAn rvalue reference to an EdgeAttributeControl to take the impl from.
Returns
A reference to this EdgeAttributeControl.
EdgeAttributeControl& HPS::EdgeAttributeControl::operator= ( EdgeAttributeControl const &  in_that)

Share the smart-pointer.

EdgeAttributeControl& HPS::EdgeAttributeControl::SetPattern ( char const *  in_pattern_name)

Specifies the pattern of edges.

Parameters
in_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
A reference to this object.
EdgeAttributeControl& HPS::EdgeAttributeControl::SetWeight ( float  in_weight,
Edge::SizeUnits  in_units = Edge::SizeUnits::ScaleFactor 
)

Sets the weight of lines drawn in edge rendering.

Parameters
in_weightThe weight value for edges.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.
bool HPS::EdgeAttributeControl::ShowPattern ( UTF8 out_pattern_name) const

Shows the line pattern of the edges.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
true if the setting is valid, false otherwise.
bool HPS::EdgeAttributeControl::ShowWeight ( float &  out_weight,
Edge::SizeUnits out_units 
) const

Shows the weight of lines drawn in edge rendering.

Parameters
out_weightThe weight value for edges.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.
EdgeAttributeControl& HPS::EdgeAttributeControl::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
EdgeAttributeControl& HPS::EdgeAttributeControl::UnsetPattern ( )

Removes the line pattern setting for edges.

Returns
A reference to this object.
EdgeAttributeControl& HPS::EdgeAttributeControl::UnsetWeight ( )

Removes the weight setting for edges.

Returns
A reference to this object.

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