VisibilityControl

class HPS.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

override void Dispose ()

override HPS.Type ObjectType ()

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).

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

HPS.VisibilityControl SetAdjacentEdges (bool in_state)

Sets the visibility of adjacent edges.

Param in_state: Whether adjacent edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetCutEdges (bool in_state)

Sets the visibility of edges cut by a cutting sections.

Param in_state: Whether cut edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetCutFaces (bool in_state)

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

Param in_state: Whether cut faces are visible.
Return: A reference to this object.

HPS.VisibilityControl SetCutGeometry (bool in_state)

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

Param in_state: Whether all cut geometry are visible.
Return: A reference to this object.

HPS.VisibilityControl SetCuttingSections (bool in_state)

Sets the visibility of cutting sections.

Param in_state: Whether cutting sections are visible.
Return: A reference to this object.

HPS.VisibilityControl SetEdgeLights (bool in_state)

Sets the visibility of lighting on edges.

Param in_state: Whether edge lights are visible.
Return: A reference to this object.

HPS.VisibilityControl SetEdges (bool in_state)

Sets the visibility of all edges.

Param in_state: Whether all edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetEverything (bool in_state)

Sets the visibility of all geometry and subgeometry.

Param in_state: Whether everything is visible.
Return: A reference to this object.

HPS.VisibilityControl SetFaceLights (bool in_state)

Sets the visibility of lighting on faces.

Param in_state: Whether face lights are visible.
Return: A reference to this object.

HPS.VisibilityControl SetFaces (bool in_state)

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

Param in_state: Whether faces are visible.
Return: A reference to this object.

HPS.VisibilityControl SetGenericEdges (bool in_state)

Sets the visibility of generic edges.

Param in_state: Whether generic edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetGeometry (bool in_state)

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

Param in_state: Whether all geometry is visible.
Return: A reference to this object.

HPS.VisibilityControl SetHardEdges (bool in_state)

Sets the visibility of hard edges.

Param in_state: Whether hard edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetInteriorSilhouetteEdges (bool in_state)

Sets the visibility of interior silhouette edges.

Param in_state: Whether interior silhouette edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetLeaderLines (bool in_state)

Sets the visibility of text leader lines.

Param in_state: Whether text leader lines are visible.
Return: A reference to this object.

HPS.VisibilityControl SetLights (bool in_state)

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

Param in_state: Whether all lights are visible.
Return: A reference to this object.

HPS.VisibilityControl SetLines (bool in_state)

Sets the visibility of lines.

Param in_state: Whether lines are visible.
Return: A reference to this object.

HPS.VisibilityControl SetMarkerLights (bool in_state)

Sets the visibility of lighting on markers and vertices.

Param in_state: Whether marker lights are visible.
Return: A reference to this object.

HPS.VisibilityControl SetMarkers (bool in_state)

Sets the visibility of markers.

Param in_state: Whether markers are visible.
Return: A reference to this object.

HPS.VisibilityControl SetMeshQuadEdges (bool in_state)

Sets the visibility of edges of mesh quads.

Param in_state: Whether mesh quad edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetNonCulledEdges (bool in_state)

Sets the visibility of non-culled edges.

Param in_state: Whether non-culled edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetPerimeterEdges (bool in_state)

Sets the visibility of perimeter edges.

Param in_state: Whether perimeter edges are visible.
Return: A reference to this object.

HPS.VisibilityControl SetShadowCasting (bool in_state)

Sets the visibility of shadow casting.

Param in_state: Whether casting shadows are visible.
Return: A reference to this object.

HPS.VisibilityControl SetShadowEmitting (bool in_state)

Sets the visibility of shadow emitting.

Param in_state: Whether emitting shadows are visible.
Return: A reference to this object.

HPS.VisibilityControl SetShadowReceiving (bool in_state)

Sets the visibility of shadow receiving.

Param in_state: Whether receiving shadows are visible.
Return: A reference to this object.

HPS.VisibilityControl SetShadows (bool in_state)

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

Param in_state: Whether all shadows are visible.
Return: A reference to this object.

HPS.VisibilityControl SetText (bool in_state)

Sets the visibility of text.

Param in_state: Whether text is visible.
Return: A reference to this object.

HPS.VisibilityControl SetVertices (bool in_state)

Sets the visibility of vertices.

Param in_state: Whether vertices are visible.
Return: A reference to this object.

HPS.VisibilityControl SetWindows (bool in_state)

Sets the visibility of windows.

Param in_state: Whether windows are visible.
Return: A reference to this object.

bool ShowAdjacentEdges (out bool out_state)

Shows the visibility setting for adjacent edges.

Param out_state: Whether adjacent edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowCutEdges (out bool out_state)

Shows the visibility setting for cut edges.

Param out_state: Whether cut edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowCutFaces (out bool out_state)

Shows the visibility setting for cut faces.

Param out_state: Whether cut faces are visible.
Return: true if the setting is valid, false otherwise.

bool ShowCuttingSections (out bool out_state)

Shows the visibility setting for cutting sections.

Param out_state: Whether cutting sections are visible.
Return: true if the setting is valid, false otherwise.

bool ShowEdgeLights (out bool out_state)

Shows the visibility setting for lighting of edges.

Param out_state: Whether edge lights are visible.
Return: true if the setting is valid, false otherwise.

bool ShowFaceLights (out bool out_state)

Shows the visibility setting for lighting of faces.

Param out_state: Whether face lights are visible.
Return: true if the setting is valid, false otherwise.

bool ShowFaces (out bool out_state)

Shows the visibility setting for faces.

Param out_state: Whether faces are visible.
Return: true if the setting is valid, false otherwise.

bool ShowGenericEdges (out bool out_state)

Shows the visibility setting for generic edges.

Param out_state: Whether generic edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowHardEdges (out bool out_state)

Shows the visibility setting for hard edges.

Param out_state: Whether hard edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowInteriorSilhouetteEdges (out bool out_state)

Shows the visibility setting for silhouette edges.

Param out_state: Whether interior silhouette edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowLeaderLines (out bool out_state)

Shows the visibility setting for text leader lines.

Param out_state: Whether text leader lines are visible.
Return: true if the setting is valid, false otherwise.

bool ShowLines (out bool out_state)

Shows the visibility setting for lines.

Param out_state: Whether lines are visible.
Return: true if the setting is valid, false otherwise.

bool ShowMarkerLights (out bool out_state)

Shows the visibility setting for lighting of markers.

Param out_state: Whether marker lights are visible.
Return: true if the setting is valid, false otherwise.

bool ShowMarkers (out bool out_state)

Shows the visibility setting for markers.

Param out_state: Whether markers are visible.
Return: true if the setting is valid, false otherwise.

bool ShowMeshQuadEdges (out bool out_state)

Shows the visibility setting for edges of mesh quads.

Param out_state: Whether mesh quad edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowNonCulledEdges (out bool out_state)

Shows the visibility setting for non-culled edges.

Param out_state: Whether non-culled edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowPerimeterEdges (out bool out_state)

Shows the visibility setting for perimeter edges.

Param out_state: Whether perimeter edges are visible.
Return: true if the setting is valid, false otherwise.

bool ShowShadowCasting (out bool out_state)

Shows the visibility setting for shadow casting.

Param out_state: Whether casting shadows are visible.
Return: true if the setting is valid, false otherwise.

bool ShowShadowEmitting (out bool out_state)

Shows the visibility setting for shadow emitting.

Param out_state: Whether emitting shadows are visible.
Return: true if the setting is valid, false otherwise.

bool ShowShadowReceiving (out bool out_state)

Shows the visibility setting for shadow receiving.

Param out_state: Whether receiving shadows are visible.
Return: true if the setting is valid, false otherwise.

bool ShowText (out bool out_state)

Shows the visibility setting for text.

Param out_state: Whether text is visible.
Return: true if the setting is valid, false otherwise.

bool ShowVertices (out bool out_state)

Shows the visibility setting for vertices.

Param out_state: Whether vertices are visible.
Return: true if the setting is valid, false otherwise.

bool ShowWindows (out bool out_state)

Shows the visibility setting for windows.

Param out_state: Whether windows are visible.
Return: true if the setting is valid, false otherwise.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

HPS.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().

Return: A reference to this object.

VisibilityControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

VisibilityControl (HPS.VisibilityControl in_that): Initializes a control tied to the same object as in_that.