EdgeGenerationOptionsKit

class EdgeGenerationOptionsKit : public HPS::Kit

Public Functions

EdgeGenerationOptionsKit()

The default constructor creates an empty EdgeGenerationOptionsKit object.

EdgeGenerationOptionsKit(EdgeGenerationOptionsKit &&in_that)

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

Parameters:in_that – An rvalue reference to a EdgeGenerationOptionsKit to take the impl from.

EdgeGenerationOptionsKit(EdgeGenerationOptionsKit const &in_kit)

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

Parameters:in_kit – The source EdgeGenerationOptionsKit to copy.

virtual bool Empty() const

Indicates whether this EdgeGenerationOptionsKit has any values set on it.

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

bool Equals(EdgeGenerationOptionsKit const &in_kit) const

Check if the source EdgeGenerationOptionsKit is equivalent to this EdgeGenerationOptionsKit.

Parameters:in_kit – The source EdgeGenerationOptionsKit to compare to this EdgeGenerationOptionsKit. Returns:true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(EdgeGenerationOptionsKit const &in_kit) const

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

Parameters:in_kit – The source EdgeGenerationOptionsKit to compare to this EdgeGenerationOptionsKit. Returns:true if the objects are not equivalent, false otherwise.

EdgeGenerationOptionsKit &operator=(EdgeGenerationOptionsKit &&in_that)

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

Parameters:in_that – An rvalue reference to a EdgeGenerationOptionsKit to take the impl from. Returns:A reference to this EdgeGenerationOptionsKit.

EdgeGenerationOptionsKit &operator=(EdgeGenerationOptionsKit const &in_kit)

Copies the source EdgeGenerationOptionsKit into this EdgeGenerationOptionsKit.

Parameters:in_kit – The source EdgeGenerationOptionsKit to copy. Returns:A reference to this EdgeGenerationOptionsKit.

bool operator==(EdgeGenerationOptionsKit const &in_kit) const

Check if the source EdgeGenerationOptionsKit is equivalent to this EdgeGenerationOptionsKit.

Parameters:in_kit – The source EdgeGenerationOptionsKit to compare to this EdgeGenerationOptionsKit. Returns:true if the objects are equivalent, false otherwise.

void Set(EdgeGenerationOptionsKit const &in_kit)

Copies the source EdgeGenerationOptionsKit into this EdgeGenerationOptionsKit.

Parameters:in_kit – The source EdgeGenerationOptionsKit to copy.

EdgeGenerationOptionsKit &SetAdjacentEdges(bool in_state)

Sets the visibility of adjacent edges. Adjacent edges are defined as edges that are attached to at least one visible face. If you want to have no edges between faces that are explicitly invisible, turn off edges in the segment and turn on adjacent edges.

Parameters:in_state – Whether adjacent edges are visible. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetDefaultEdges(bool in_state)

Sets the default visibility of all edges, assumed on if not specified

Parameters:in_state – Whether all edges are visible. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetDefaultFaces(bool in_state)

Sets the default visibility of all faces, assumed on if not specified

Parameters:in_state – Whether faces are visible. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetHardEdgeDihedral(float in_dihedral)

Sets the angle used to determine if adjacent edges form a hard edge.

Parameters:in_dihedral – the hard edge cutoff angle. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetHardEdges(bool in_state)

Sets the visibility of hard edges.

Parameters:in_state – Whether hard edges are visible. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetIgnoreLocalEdges(bool in_state)

Sets whether local face visibility will be considered.

Parameters:in_state – Whether local edge visibility is considered. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetIgnoreLocalFaces(bool in_state)

Sets whether local face visibility will be considered.

Parameters:in_state – Whether local face visibility is considered. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetMeshQuadEdges(bool in_state)

Sets the visibility of edges of mesh quads.

Parameters:in_state – Whether mesh quad edges are visible. Returns:A reference to this object.

EdgeGenerationOptionsKit &SetPerimeterEdges(bool in_state)

Sets the visibility of perimeter edges.

Parameters:in_state – Whether perimeter edges are visible. Returns:A reference to this object.

void Show(EdgeGenerationOptionsKit &out_kit) const

Copies this EdgeGenerationOptionsKit into the given EdgeGenerationOptionsKit.

Parameters:out_kit – The EdgeGenerationOptionsKit to populate with the contents of this EdgeGenerationOptionsKit.

bool ShowAdjacentEdges(bool &out_state) const

Shows the visibility setting for adjacent edges.

Parameters:out_state – Whether adjacent edges are visible. Returns:true if the setting is valid, false otherwise.

bool ShowDefaultEdges(bool &out_state) const

Shows the default visibility setting for edges.

Parameters:out_state – Whether edges are considered visible by default. Returns:true if the setting is valid, false otherwise.

bool ShowDefaultFaces(bool &out_state) const

Shows the default visibility setting for faces.

Parameters:out_state – Whether faces are considered visible by default. Returns:true if the setting is valid, false otherwise.

bool ShowHardEdgeDihedral(float &out_dihedral) const

Shows the angle limit for determination of hard edges.

Parameters:out_dihedral – dihedral angle limit. Returns:true if the setting is valid, false otherwise.

bool ShowHardEdges(bool &out_state) const

Shows the visibility setting for hard edges.

Parameters:out_state – Whether hard edges are visible. Returns:true if the setting is valid, false otherwise.

bool ShowIgnoreLocalEdges(bool &out_state) const

Shows whether any local edge visibility settings will be considered.

Parameters:out_state – Whether local edge visibility settings will be considered. Returns:true if the setting is valid, false otherwise.

bool ShowIgnoreLocalFaces(bool &out_state) const

Shows whether any local face visibility settings will be considered.

Parameters:out_state – Whether local face visibility settings will be considered. Returns:true if the setting is valid, false otherwise.

bool ShowMeshQuadEdges(bool &out_state) const

Shows the visibility setting for edges of mesh quads.

Parameters:out_state – Whether mesh quad edges are visible. Returns:true if the setting is valid, false otherwise.

bool ShowPerimeterEdges(bool &out_state) const

Shows the visibility setting for perimeter edges.

Parameters:out_state – Whether perimeter edges are visible. Returns:true if the setting is valid, false otherwise.

EdgeGenerationOptionsKit &UnsetAdjacentEdges()

Removes the visibility setting for adjacent edges.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetDefaultEdges()

Removes the default visibility settings for all edges.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetDefaultFaces()

Removes the default visibility setting for faces.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetEverything()

Removes all visibility settings.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetHardEdgeDihedral()

Removes the settings for the hard edge dihedral angle.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetHardEdges()

Removes the visibility setting for hard edges.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetIgnoreLocalEdges()

Removes the setting for ignoring local edge visibility.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetIgnoreLocalFaces()

Removes the setting for ignoring local face visibility.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetMeshQuadEdges()

Removes the visibility setting for edges of mesh quads.

Returns:A reference to this object.

EdgeGenerationOptionsKit &UnsetPerimeterEdges()

Removes the visibility setting for perimeter edges.

Returns:A reference to this object.

virtual ~EdgeGenerationOptionsKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::EdgeGenerationOptionsKit