VisibilityKit

class HPS::VisibilityKit : public HPS::Kit 

The HPS::VisibilityKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::VisibilityKit::GetDefault() will return a kit with values found in this table.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

bool Equals(VisibilityKit const &in_kit) const

Check if the source VisibilityKit is equivalent to this object.

Parameters: in_kit – The source VisibilityKit to compare to this object.
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!=(VisibilityKit const &in_kit) const

Check if the source VisibilityKit is not equivalent to this object.

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

VisibilityKit &operator=(VisibilityKit &&in_that)

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

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

VisibilityKit &operator=(VisibilityKit const &in_kit)

Copies the source VisibilityKit into this object.

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

bool operator==(VisibilityKit const &in_kit) const

Check if the source VisibilityKit is equivalent to this object.

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

void Set(VisibilityKit const &in_kit)

Copies all settings from the source VisibilityKit into this object.

Parameters: in_kit – The source VisibilityKit to copy.

VisibilityKit &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.

VisibilityKit &SetCutEdges(bool in_state)

Sets the visibility of edges cut by a cutting sections.

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

VisibilityKit &SetCutFaces(bool in_state)

Sets the visibility of capping planes for geometry cut by cutting sections.

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

VisibilityKit &SetCutGeometry(bool in_state)

Sets the visibility of cut geometry, both cut faces and cut edges.

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

VisibilityKit &SetCuttingSections(bool in_state)

Enables or disables cutting sections based on the parameter value. An ‘enabled’ cutting section means it is actively cutting geometry contained in this segment and its subsegments.

Parameters: in_state – If true, enables visibility of cutting sections. If false, cutting sections are disabled.
Returns: A reference to this object.

VisibilityKit &SetEdgeLights(bool in_state)

Sets the visibility of lighting on edges.

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

VisibilityKit &SetEdges(bool in_state)

Sets the visibility of all edges.

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

VisibilityKit &SetEverything(bool in_state)

Sets the visibility of all geometry and subgeometry.

Parameters: in_state – Whether everything is visible.
Returns: A reference to this object.

VisibilityKit &SetFaceLights(bool in_state)

Sets the visibility of lighting on faces.

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

VisibilityKit &SetFaces(bool in_state)

Sets the visibility of all faces, including shells, meshes, cylinders, etc..

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

VisibilityKit &SetGenericEdges(bool in_state)

Sets the visibility of generic edges.

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

VisibilityKit &SetGeometry(bool in_state)

Sets the visibility of all edges, faces, lines, markers, and text.

Parameters: in_state – Whether all geometry is visible.
Returns: A reference to this object.

VisibilityKit &SetHardEdges(bool in_state)

Sets the visibility of hard edges.

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

VisibilityKit &SetInteriorSilhouetteEdges(bool in_state)

Sets the visibility of interior silhouette edges.

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

VisibilityKit &SetLeaderLines(bool in_state)

Sets the visibility of text leader lines.

Parameters: in_state – Whether text leader lines are visible
Returns: A reference to this object.

VisibilityKit &SetLights(bool in_state)

Sets the visibility of all lights, including face, edge, and marker lights.

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

VisibilityKit &SetLines(bool in_state)

Sets the visibility of lines.

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

VisibilityKit &SetMarkerLights(bool in_state)

Sets the visibility of lighting on markers.

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

VisibilityKit &SetMarkers(bool in_state)

Sets the visibility of markers.

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

VisibilityKit &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.

VisibilityKit &SetNonCulledEdges(bool in_state)

Sets the visibility of non-culled edges.

Parameters: in_state – Whether non-culled edges are visible.
Returns: A reference to this object.

VisibilityKit &SetPerimeterEdges(bool in_state)

Sets the visibility of perimeter edges.

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

VisibilityKit &SetShadowCasting(bool in_state)

Sets the visibility of shadow casting.

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

VisibilityKit &SetShadowEmitting(bool in_state)

Sets the visibility of shadow emitting.

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

VisibilityKit &SetShadowReceiving(bool in_state)

Sets the visibility of shadow receiving.

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

VisibilityKit &SetShadows(bool in_state)

Sets the visibility of shadow casting, emitting, and receiving.

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

VisibilityKit &SetText(bool in_state)

Sets the visibility of text.

Parameters: in_state – Whether text is visible.
Returns: A reference to this object.

VisibilityKit &SetVertices(bool in_state)

Sets the visibility of vertices.

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

VisibilityKit &SetWindows(bool in_state)

Sets the visibility of windows.

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

void Show(VisibilityKit &out_kit) const

Copies all settings from this VisibilityKit into the given VisibilityKit.

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

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 ShowCutEdges(bool &out_state) const

Shows the visibility setting for cut edges.

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

bool ShowCutFaces(bool &out_state) const

Shows the visibility setting for cut faces.

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

bool ShowCuttingSections(bool &out_state) const

Shows the visibility setting for cutting sections.

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

bool ShowEdgeLights(bool &out_state) const

Shows the visibility setting for lighting of edges.

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

bool ShowFaceLights(bool &out_state) const

Shows the visibility setting for lighting of faces.

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

bool ShowFaces(bool &out_state) const

Shows the visibility setting for faces.

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

bool ShowGenericEdges(bool &out_state) const

Shows the visibility setting for generic edges.

Parameters: out_state – Whether generic edges are visible.
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 ShowInteriorSilhouetteEdges(bool &out_state) const

Shows the visibility setting for silhouette edges.

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

bool ShowLeaderLines(bool &out_state) const

Shows the visibility setting for text leader lines.

Parameters: out_state – Whether text leader lines are visible.
Returns: true if the setting is valid, false otherwise.

bool ShowLines(bool &out_state) const

Shows the visibility setting for lines.

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

bool ShowMarkerLights(bool &out_state) const

Shows the visibility setting for lighting of markers.

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

bool ShowMarkers(bool &out_state) const

Shows the visibility setting for markers.

Parameters: out_state – Whether markers are visible.
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 ShowNonCulledEdges(bool &out_state) const

Shows the visibility setting for non-culled edges.

Parameters: out_state – Whether non-culled 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.

bool ShowShadowCasting(bool &out_state) const

Shows the visibility setting for shadow casting.

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

bool ShowShadowEmitting(bool &out_state) const

Shows the visibility setting for shadow emitting.

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

bool ShowShadowReceiving(bool &out_state) const

Shows the visibility setting for shadow receiving.

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

bool ShowText(bool &out_state) const

Shows the visibility setting for text.

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

bool ShowVertices(bool &out_state) const

Shows the visibility setting for vertices.

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

bool ShowWindows(bool &out_state) const

Shows the visibility setting for windows.

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

VisibilityKit &UnsetAdjacentEdges()

Removes the visibility setting for adjacent edges.

Returns: A reference to this object.

VisibilityKit &UnsetCutEdges()

Removes the visibility setting for cut edges.

Returns: A reference to this object.

VisibilityKit &UnsetCutFaces()

Removes the visibility setting for cut faces.

Returns: A reference to this object.

VisibilityKit &UnsetCutGeometry()

Removes the visibility settings for both cut faces and cut edges.

Returns: A reference to this object.

VisibilityKit &UnsetCuttingSections()

Removes the visibility setting for cutting sections.

Returns: A reference to this object.

VisibilityKit &UnsetEdgeLights()

Removes the visibility setting for lighting of edges.

Returns: A reference to this object.

VisibilityKit &UnsetEdges()

Removes the visibility settings for all edges.

Returns: A reference to this object.

VisibilityKit &UnsetEverything()

Removes all visibility settings.

Returns: A reference to this object.

VisibilityKit &UnsetFaceLights()

Removes the visibility setting for lighting of faces.

Returns: A reference to this object.

VisibilityKit &UnsetFaces()

Removes the visibility setting for faces.

Returns: A reference to this object.

VisibilityKit &UnsetGenericEdges()

Removes the visibility setting for generic edges.

Returns: A reference to this object.

VisibilityKit &UnsetGeometry()

Removes the visibility settings for all edges, faces, lines, markers, and text.

Returns: A reference to this object.

VisibilityKit &UnsetHardEdges()

Removes the visibility setting for hard edges.

Returns: A reference to this object.

VisibilityKit &UnsetInteriorSilhouetteEdges()

Removes the visibility setting for interior silhouette edges.

Returns: A reference to this object.

VisibilityKit &UnsetLeaderLines()

Removes the visibility settings for text leader lines.

Returns: A reference to this object.

VisibilityKit &UnsetLights()

Removes the visibility settings for all lights, including face, edge, and marker lights.

Returns: A reference to this object.

VisibilityKit &UnsetLines()

Removes the visibility setting for lines.

Returns: A reference to this object.

VisibilityKit &UnsetMarkerLights()

Removes the visibility setting for lighting or markers.

Returns: A reference to this object.

VisibilityKit &UnsetMarkers()

Removes the visibility setting for markers.

Returns: A reference to this object.

VisibilityKit &UnsetMeshQuadEdges()

Removes the visibility setting for edges of mesh quads.

Returns: A reference to this object.

VisibilityKit &UnsetNonCulledEdges()

Removes the visibility setting for non-culled edges.

Returns: A reference to this object.

VisibilityKit &UnsetPerimeterEdges()

Removes the visibility setting for perimeter edges.

Returns: A reference to this object.

VisibilityKit &UnsetShadowCasting()

Removes the visibility setting for shadow casting.

Returns: A reference to this object.

VisibilityKit &UnsetShadowEmitting()

Removes the visibility setting for shadow emitting.

Returns: A reference to this object.

VisibilityKit &UnsetShadowReceiving()

Removes the visibility setting for shadow receiving.

Returns: A reference to this object.

VisibilityKit &UnsetShadows()

Removes the visibility settings for shadow casting, emitting, and receiving.

Returns: A reference to this object.

VisibilityKit &UnsetText()

Removes the visibility setting for text.

Returns: A reference to this object.

VisibilityKit &UnsetVertices()

Removes the visibility setting for vertices.

Returns: A reference to this object.

VisibilityKit &UnsetWindows()

Removes the visibility setting for windows.

Returns: A reference to this object.

VisibilityKit(): Initializes an empty kit.

VisibilityKit(VisibilityKit &&in_that)

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

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

VisibilityKit(VisibilityKit const &in_kit)

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

Parameters: in_kit – The source object to copy.

virtual ~VisibilityKit(): Destroy this kit.

Public Static Functions

static VisibilityKit GetDefault()

Creates a VisibilityKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: A VisibilityKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::VisibilityKit