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

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.VisibilityKit in_kit)

Check if the source VisibilityKit is equivalent to this object.

Param in_kit: The source VisibilityKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

void Set (HPS.VisibilityKit in_kit)

Copies all settings from the source VisibilityKit into this object.

Param in_kit: The source VisibilityKit to copy.

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

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

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

Param in_state: If true, enables visibility of cutting sections. If false, cutting sections are disabled.
Return: A reference to this object.

HPS.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit SetLines (bool in_state)

Sets the visibility of lines.

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

HPS.VisibilityKit SetMarkerLights (bool in_state)

Sets the visibility of lighting on markers.

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

HPS.VisibilityKit SetMarkers (bool in_state)

Sets the visibility of markers.

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

HPS.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit 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.VisibilityKit SetText (bool in_state)

Sets the visibility of text.

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

HPS.VisibilityKit SetVertices (bool in_state)

Sets the visibility of vertices.

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

HPS.VisibilityKit SetWindows (bool in_state)

Sets the visibility of windows.

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

void Show (out HPS.VisibilityKit out_kit)

Copies all settings from this VisibilityKit into the given VisibilityKit.

Param out_kit: The VisibilityKit to populate with the contents of 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.VisibilityKit UnsetAdjacentEdges ()

Removes the visibility setting for adjacent edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetCutEdges ()

Removes the visibility setting for cut edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetCutFaces ()

Removes the visibility setting for cut faces.

Return: A reference to this object.

HPS.VisibilityKit UnsetCutGeometry ()

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

Return: A reference to this object.

HPS.VisibilityKit UnsetCuttingSections ()

Removes the visibility setting for cutting sections.

Return: A reference to this object.

HPS.VisibilityKit UnsetEdgeLights ()

Removes the visibility setting for lighting of edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetEdges ()

Removes the visibility settings for all edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetEverything ()

Removes all visibility settings.

Return: A reference to this object.

HPS.VisibilityKit UnsetFaceLights ()

Removes the visibility setting for lighting of faces.

Return: A reference to this object.

HPS.VisibilityKit UnsetFaces ()

Removes the visibility setting for faces.

Return: A reference to this object.

HPS.VisibilityKit UnsetGenericEdges ()

Removes the visibility setting for generic edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetGeometry ()

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

Return: A reference to this object.

HPS.VisibilityKit UnsetHardEdges ()

Removes the visibility setting for hard edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetInteriorSilhouetteEdges ()

Removes the visibility setting for interior silhouette edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetLeaderLines ()

Removes the visibility settings for text leader lines.

Return: A reference to this object.

HPS.VisibilityKit UnsetLights ()

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

Return: A reference to this object.

HPS.VisibilityKit UnsetLines ()

Removes the visibility setting for lines.

Return: A reference to this object.

HPS.VisibilityKit UnsetMarkerLights ()

Removes the visibility setting for lighting or markers.

Return: A reference to this object.

HPS.VisibilityKit UnsetMarkers ()

Removes the visibility setting for markers.

Return: A reference to this object.

HPS.VisibilityKit UnsetMeshQuadEdges ()

Removes the visibility setting for edges of mesh quads.

Return: A reference to this object.

HPS.VisibilityKit UnsetNonCulledEdges ()

Removes the visibility setting for non-culled edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetPerimeterEdges ()

Removes the visibility setting for perimeter edges.

Return: A reference to this object.

HPS.VisibilityKit UnsetShadowCasting ()

Removes the visibility setting for shadow casting.

Return: A reference to this object.

HPS.VisibilityKit UnsetShadowEmitting ()

Removes the visibility setting for shadow emitting.

Return: A reference to this object.

HPS.VisibilityKit UnsetShadowReceiving ()

Removes the visibility setting for shadow receiving.

Return: A reference to this object.

HPS.VisibilityKit UnsetShadows ()

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

Return: A reference to this object.

HPS.VisibilityKit UnsetText ()

Removes the visibility setting for text.

Return: A reference to this object.

HPS.VisibilityKit UnsetVertices ()

Removes the visibility setting for vertices.

Return: A reference to this object.

HPS.VisibilityKit UnsetWindows ()

Removes the visibility setting for windows.

Return: A reference to this object.

VisibilityKit (): Initializes an empty kit.

VisibilityKit (HPS.VisibilityKit in_kit)

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

Param in_kit: The source object to copy.

Public Static Functions

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

Return: A VisibilityKit with the default settings.

bool operator!= (HPS.VisibilityKit a, HPS.VisibilityKit b)

bool operator== (HPS.VisibilityKit a, HPS.VisibilityKit b)