VisibilityControl

class VisibilityControl : public HPS::Control

The HPS::VisibilityControl class is a smart pointer that is tied to a database object. This control allows you to set and unset the visibility of any type of geometry or subentity in the scene. The visibility of windows is also controlled here. Additionally, various behaviors such as casting and emitting shadows is also done through this control.

Default values for the various fields of HPS::VisibilityControl can be found here.

Public Functions

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.

VisibilityControl &operator=(VisibilityControl &&in_that)

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

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

VisibilityControl &operator=(VisibilityControl const &in_that)

Share the underlying smart-pointer of the VisibilityControl source.

Parameters:in_that – The VisibilityControl source of the assignment. Returns:A reference to this VisibilityControl.

VisibilityControl &SetAdjacentEdges(bool in_state)

Sets the visibility of adjacent edges.

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

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

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

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

VisibilityControl &SetCuttingSections(bool in_state)

Sets the visibility of cutting sections.

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

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

VisibilityControl &SetEdges(bool in_state)

Sets the visibility of all edges.

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

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

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

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

VisibilityControl &SetGenericEdges(bool in_state)

Sets the visibility of generic edges.

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

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

VisibilityControl &SetHardEdges(bool in_state)

Sets the visibility of hard edges.

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

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

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

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

VisibilityControl &SetLines(bool in_state)

Sets the visibility of lines.

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

VisibilityControl &SetMarkerLights(bool in_state)

Sets the visibility of lighting on markers and vertices.

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

VisibilityControl &SetMarkers(bool in_state)

Sets the visibility of markers.

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

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

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

VisibilityControl &SetPerimeterEdges(bool in_state)

Sets the visibility of perimeter edges.

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

VisibilityControl &SetShadowCasting(bool in_state)

Sets the visibility of shadow casting.

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

VisibilityControl &SetShadowEmitting(bool in_state)

Sets the visibility of shadow emitting.

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

VisibilityControl &SetShadowReceiving(bool in_state)

Sets the visibility of shadow receiving.

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

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

VisibilityControl &SetText(bool in_state)

Sets the visibility of text.

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

VisibilityControl &SetVertices(bool in_state)

Sets the visibility of vertices.

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

VisibilityControl &SetWindows(bool in_state)

Sets the visibility of windows.

Parameters:in_state – Whether windows are visible. Returns:A reference to 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.

VisibilityControl &UnsetAdjacentEdges()

Removes the visibility setting for adjacent edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetCutEdges()

Removes the visibility setting for cut edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetCutFaces()

Removes the visibility setting for cut faces. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetCutGeometry()

Removes the visibility settings for both cut faces and cut edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetCuttingSections()

Removes the visibility setting for cutting sections. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetEdgeLights()

Removes the visibility setting for lighting of edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetEdges()

Removes the visibility settings for all edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetEverything()

Removes all visibility settings. If the control is attached to a WindowKey this function restores the default settings of this control as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetFaceLights()

Removes the visibility setting for lighting of faces. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetFaces()

Removes the visibility setting for faces. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetGenericEdges()

Removes the visibility setting for generic edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetGeometry()

Removes the visibility settings for all edges, faces, lines, markers, and text. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetHardEdges()

Removes the visibility setting for hard edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetInteriorSilhouetteEdges()

Removes the visibility setting for interior silhouette edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetLeaderLines()

Removes the visibility settings for text leader lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetLights()

Removes the visibility settings for all lights, including face, edge, and marker lights. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetLines()

Removes the visibility setting for lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetMarkerLights()

Removes the visibility setting for lighting or markers. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetMarkers()

Removes the visibility setting for markers. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetMeshQuadEdges()

Removes the visibility setting for edges of mesh quads. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetNonCulledEdges()

Removes the visibility setting for non-culled edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetPerimeterEdges()

Removes the visibility setting for perimeter edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetShadowCasting()

Removes the visibility setting for shadow casting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetShadowEmitting()

Removes the visibility setting for shadow emitting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetShadowReceiving()

Removes the visibility setting for shadow receiving. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetShadows()

Removes the visibility settings for shadow casting, emitting, and receiving. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetText()

Removes the visibility setting for text. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetVertices()

Removes the visibility setting for vertices. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

VisibilityControl &UnsetWindows()

Removes the visibility setting for windows. If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisibilityKit::GetDefault().

Returns:A reference to this object.

explicit VisibilityControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

VisibilityControl(VisibilityControl &&in_that)

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

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

VisibilityControl(VisibilityControl const &in_that)

Initializes a control tied to the same object as in_that.

~VisibilityControl()

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

Public Static Attributes

static const HPS::Type staticType = HPS::Type::VisibilityControl