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. More...
Public Member Functions | |
override void | Dispose () |
VisibilityKit () | |
Initializes an empty kit. More... | |
VisibilityKit (HPS.VisibilityKit in_kit) | |
The copy constructor creates a new VisibilityKit object that contains the same settings as the source object. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.VisibilityKit in_kit) |
Copies all settings from the source VisibilityKit into this object. More... | |
void | Show (out HPS.VisibilityKit out_kit) |
Copies all settings from this VisibilityKit into the given VisibilityKit. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.VisibilityKit in_kit) |
Check if the source VisibilityKit is equivalent to this object. More... | |
HPS.VisibilityKit | SetCuttingSections (bool in_state) |
Sets the visibility of cutting sections. More... | |
HPS.VisibilityKit | SetCutEdges (bool in_state) |
Sets the visibility of edges cut by a cutting sections. More... | |
HPS.VisibilityKit | SetCutFaces (bool in_state) |
Sets the visibility of capping planes for geometry cut by cutting sections. More... | |
HPS.VisibilityKit | SetWindows (bool in_state) |
Sets the visibility of windows. More... | |
HPS.VisibilityKit | SetText (bool in_state) |
Sets the visibility of text. More... | |
HPS.VisibilityKit | SetLines (bool in_state) |
Sets the visibility of lines. More... | |
HPS.VisibilityKit | SetEdgeLights (bool in_state) |
Sets the visibility of lighting on edges. More... | |
HPS.VisibilityKit | SetMarkerLights (bool in_state) |
Sets the visibility of lighting on markers. More... | |
HPS.VisibilityKit | SetFaceLights (bool in_state) |
Sets the visibility of lighting on faces. More... | |
HPS.VisibilityKit | SetGenericEdges (bool in_state) |
Sets the visibility of generic edges. More... | |
HPS.VisibilityKit | SetInteriorSilhouetteEdges (bool in_state) |
Sets the visibility of interior silhouette edges. More... | |
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. More... | |
HPS.VisibilityKit | SetHardEdges (bool in_state) |
Sets the visibility of hard edges. More... | |
HPS.VisibilityKit | SetMeshQuadEdges (bool in_state) |
Sets the visibility of edges of mesh quads. More... | |
HPS.VisibilityKit | SetNonCulledEdges (bool in_state) |
Sets the visibility of non-culled edges. More... | |
HPS.VisibilityKit | SetPerimeterEdges (bool in_state) |
Sets the visibility of perimeter edges. More... | |
HPS.VisibilityKit | SetFaces (bool in_state) |
Sets the visibility of all faces, including shells, meshes, cylinders, etc.. More... | |
HPS.VisibilityKit | SetVertices (bool in_state) |
Sets the visibility of vertices. More... | |
HPS.VisibilityKit | SetMarkers (bool in_state) |
Sets the visibility of markers. More... | |
HPS.VisibilityKit | SetShadowCasting (bool in_state) |
Sets the visibility of shadow casting. More... | |
HPS.VisibilityKit | SetShadowReceiving (bool in_state) |
Sets the visibility of shadow receiving. More... | |
HPS.VisibilityKit | SetShadowEmitting (bool in_state) |
Sets the visibility of shadow emitting. More... | |
HPS.VisibilityKit | SetCutGeometry (bool in_state) |
Sets the visibility of cut geometry, both cut faces and cut edges. More... | |
HPS.VisibilityKit | SetEdges (bool in_state) |
Sets the visibility of all edges. More... | |
HPS.VisibilityKit | SetGeometry (bool in_state) |
Sets the visibility of all edges, faces, lines, markers, and text. More... | |
HPS.VisibilityKit | SetLights (bool in_state) |
Sets the visibility of all lights, including face, edge, and marker lights. More... | |
HPS.VisibilityKit | SetShadows (bool in_state) |
Sets the visibility of shadow casting, emitting, and receiving. More... | |
HPS.VisibilityKit | SetEverything (bool in_state) |
Sets the visibility of all geometry and subgeometry. More... | |
HPS.VisibilityKit | UnsetCuttingSections () |
Removes the visibility setting for cutting sections. More... | |
HPS.VisibilityKit | UnsetCutEdges () |
Removes the visibility setting for cut edges. More... | |
HPS.VisibilityKit | UnsetCutFaces () |
Removes the visibility setting for cut faces. More... | |
HPS.VisibilityKit | UnsetWindows () |
Removes the visibility setting for windows. More... | |
HPS.VisibilityKit | UnsetText () |
Removes the visibility setting for text. More... | |
HPS.VisibilityKit | UnsetLines () |
Removes the visibility setting for lines. More... | |
HPS.VisibilityKit | UnsetEdgeLights () |
Removes the visibility setting for lighting of edges. More... | |
HPS.VisibilityKit | UnsetMarkerLights () |
Removes the visibility setting for lighting or markers. More... | |
HPS.VisibilityKit | UnsetFaceLights () |
Removes the visibility setting for lighting of faces. More... | |
HPS.VisibilityKit | UnsetGenericEdges () |
Removes the visibility setting for generic edges. More... | |
HPS.VisibilityKit | UnsetInteriorSilhouetteEdges () |
Removes the visibility setting for interior silhouette edges. More... | |
HPS.VisibilityKit | UnsetAdjacentEdges () |
Removes the visibility setting for adjacent edges. More... | |
HPS.VisibilityKit | UnsetHardEdges () |
Removes the visibility setting for hard edges. More... | |
HPS.VisibilityKit | UnsetMeshQuadEdges () |
Removes the visibility setting for edges of mesh quads. More... | |
HPS.VisibilityKit | UnsetNonCulledEdges () |
Removes the visibility setting for non-culled edges. More... | |
HPS.VisibilityKit | UnsetPerimeterEdges () |
Removes the visibility setting for perimeter edges. More... | |
HPS.VisibilityKit | UnsetFaces () |
Removes the visibility setting for faces. More... | |
HPS.VisibilityKit | UnsetVertices () |
Removes the visibility setting for vertices. More... | |
HPS.VisibilityKit | UnsetMarkers () |
Removes the visibility setting for markers. More... | |
HPS.VisibilityKit | UnsetShadowCasting () |
Removes the visibility setting for shadow casting. More... | |
HPS.VisibilityKit | UnsetShadowReceiving () |
Removes the visibility setting for shadow receiving. More... | |
HPS.VisibilityKit | UnsetShadowEmitting () |
Removes the visibility setting for shadow emitting. More... | |
HPS.VisibilityKit | UnsetCutGeometry () |
Removes the visibility settings for both cut faces and cut edges. More... | |
HPS.VisibilityKit | UnsetEdges () |
Removes the visibility settings for all edges. More... | |
HPS.VisibilityKit | UnsetGeometry () |
Removes the visibility settings for all edges, faces, lines, markers, and text. More... | |
HPS.VisibilityKit | UnsetLights () |
Removes the visibility settings for all lights, including face, edge, and marker lights. More... | |
HPS.VisibilityKit | UnsetShadows () |
Removes the visibility settings for shadow casting, emitting, and receiving. More... | |
HPS.VisibilityKit | UnsetEverything () |
Removes all visibility settings. More... | |
bool | ShowCuttingSections (out bool out_state) |
Shows the visibility setting for cutting sections. More... | |
bool | ShowCutEdges (out bool out_state) |
Shows the visibility setting for cut edges. More... | |
bool | ShowCutFaces (out bool out_state) |
Shows the visibility setting for cut faces. More... | |
bool | ShowWindows (out bool out_state) |
Shows the visibility setting for windows. More... | |
bool | ShowText (out bool out_state) |
Shows the visibility setting for text. More... | |
bool | ShowLines (out bool out_state) |
Shows the visibility setting for lines. More... | |
bool | ShowEdgeLights (out bool out_state) |
Shows the visibility setting for lighting of edges. More... | |
bool | ShowMarkerLights (out bool out_state) |
Shows the visibility setting for lighting of markers. More... | |
bool | ShowFaceLights (out bool out_state) |
Shows the visibility setting for lighting of faces. More... | |
bool | ShowGenericEdges (out bool out_state) |
Shows the visibility setting for generic edges. More... | |
bool | ShowInteriorSilhouetteEdges (out bool out_state) |
Shows the visibility setting for silhouette edges. More... | |
bool | ShowAdjacentEdges (out bool out_state) |
Shows the visibility setting for adjacent edges. More... | |
bool | ShowHardEdges (out bool out_state) |
Shows the visibility setting for hard edges. More... | |
bool | ShowMeshQuadEdges (out bool out_state) |
Shows the visibility setting for edges of mesh quads. More... | |
bool | ShowNonCulledEdges (out bool out_state) |
Shows the visibility setting for non-culled edges. More... | |
bool | ShowPerimeterEdges (out bool out_state) |
Shows the visibility setting for perimeter edges. More... | |
bool | ShowFaces (out bool out_state) |
Shows the visibility setting for faces. More... | |
bool | ShowVertices (out bool out_state) |
Shows the visibility setting for vertices. More... | |
bool | ShowMarkers (out bool out_state) |
Shows the visibility setting for markers. More... | |
bool | ShowShadowCasting (out bool out_state) |
Shows the visibility setting for shadow casting. More... | |
bool | ShowShadowReceiving (out bool out_state) |
Shows the visibility setting for shadow receiving. More... | |
bool | ShowShadowEmitting (out bool out_state) |
Shows the visibility setting for shadow emitting. More... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator== (HPS.VisibilityKit a, HPS.VisibilityKit b) |
static bool | operator!= (HPS.VisibilityKit a, HPS.VisibilityKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new VisibilityKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
inlinevirtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source VisibilityKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_visibility_kit" kindref="compound">VisibilityKit</ref> to compare to this object. |
|
inlinestatic |
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies all settings from the source VisibilityKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_visibility_kit" kindref="compound">VisibilityKit</ref> to copy. |
|
inline |
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.
in_state | Whether adjacent edges are visible. |
|
inline |
Sets the visibility of edges cut by a cutting sections.
in_state | Whether cut edges are visible. |
|
inline |
Sets the visibility of capping planes for geometry cut by cutting sections.
in_state | Whether cut faces are visible. |
|
inline |
Sets the visibility of cut geometry, both cut faces and cut edges.
in_state | Whether all cut geometry are visible. |
|
inline |
Sets the visibility of cutting sections.
in_state | Whether cutting sections are visible. |
|
inline |
Sets the visibility of lighting on edges.
in_state | Whether edge lights are visible. |
|
inline |
Sets the visibility of all edges.
in_state | Whether all edges are visible. |
|
inline |
Sets the visibility of all geometry and subgeometry.
in_state | Whether everything is visible. |
|
inline |
Sets the visibility of lighting on faces.
in_state | Whether face lights are visible. |
|
inline |
Sets the visibility of all faces, including shells, meshes, cylinders, etc..
in_state | Whether faces are visible. |
|
inline |
Sets the visibility of generic edges.
in_state | Whether generic edges are visible. |
|
inline |
Sets the visibility of all edges, faces, lines, markers, and text.
in_state | Whether all geometry is visible. |
|
inline |
Sets the visibility of hard edges.
in_state | Whether hard edges are visible. |
|
inline |
Sets the visibility of interior silhouette edges.
in_state | Whether interior silhouette edges are visible. |
|
inline |
Sets the visibility of all lights, including face, edge, and marker lights.
in_state | Whether all lights are visible. |
|
inline |
Sets the visibility of lines.
in_state | Whether lines are visible. |
|
inline |
Sets the visibility of lighting on markers.
in_state | Whether marker lights are visible. |
|
inline |
Sets the visibility of markers.
in_state | Whether markers are visible. |
|
inline |
Sets the visibility of edges of mesh quads.
in_state | Whether mesh quad edges are visible. |
|
inline |
Sets the visibility of non-culled edges.
in_state | Whether non-culled edges are visible. |
|
inline |
Sets the visibility of perimeter edges.
in_state | Whether perimeter edges are visible. |
|
inline |
Sets the visibility of shadow casting.
in_state | Whether casting shadows are visible. |
|
inline |
Sets the visibility of shadow emitting.
in_state | Whether emitting shadows are visible. |
|
inline |
Sets the visibility of shadow receiving.
in_state | Whether receiving shadows are visible. |
|
inline |
Sets the visibility of shadow casting, emitting, and receiving.
in_state | Whether all shadows are visible. |
|
inline |
Sets the visibility of text.
in_state | Whether text is visible. |
|
inline |
Sets the visibility of vertices.
in_state | Whether vertices are visible. |
|
inline |
Sets the visibility of windows.
in_state | Whether windows are visible. |
|
inline |
Copies all settings from this VisibilityKit into the given VisibilityKit.
out_kit | The <ref refid="class_h_p_s_1_1_visibility_kit" kindref="compound">VisibilityKit</ref> to populate with the contents of this object. |
|
inline |
Shows the visibility setting for adjacent edges.
out_state | Whether adjacent edges are visible. |
|
inline |
Shows the visibility setting for cut edges.
out_state | Whether cut edges are visible. |
|
inline |
Shows the visibility setting for cut faces.
out_state | Whether cut faces are visible. |
|
inline |
Shows the visibility setting for cutting sections.
out_state | Whether cutting sections are visible. |
|
inline |
Shows the visibility setting for lighting of edges.
out_state | Whether edge lights are visible. |
|
inline |
Shows the visibility setting for lighting of faces.
out_state | Whether face lights are visible. |
|
inline |
Shows the visibility setting for faces.
out_state | Whether faces are visible. |
|
inline |
Shows the visibility setting for generic edges.
out_state | Whether generic edges are visible. |
|
inline |
Shows the visibility setting for hard edges.
out_state | Whether hard edges are visible. |
|
inline |
Shows the visibility setting for silhouette edges.
out_state | Whether interior silhouette edges are visible. |
|
inline |
Shows the visibility setting for lines.
out_state | Whether lines are visible. |
|
inline |
Shows the visibility setting for lighting of markers.
out_state | Whether marker lights are visible. |
|
inline |
Shows the visibility setting for markers.
out_state | Whether markers are visible. |
|
inline |
Shows the visibility setting for edges of mesh quads.
out_state | Whether mesh quad edges are visible. |
|
inline |
Shows the visibility setting for non-culled edges.
out_state | Whether non-culled edges are visible. |
|
inline |
Shows the visibility setting for perimeter edges.
out_state | Whether perimeter edges are visible. |
|
inline |
Shows the visibility setting for shadow casting.
out_state | Whether casting shadows are visible. |
|
inline |
Shows the visibility setting for shadow emitting.
out_state | Whether emitting shadows are visible. |
|
inline |
Shows the visibility setting for shadow receiving.
out_state | Whether receiving shadows are visible. |
|
inline |
Shows the visibility setting for text.
out_state | Whether text is visible. |
|
inline |
Shows the visibility setting for vertices.
out_state | Whether vertices are visible. |
|
inline |
Shows the visibility setting for windows.
out_state | Whether windows are visible. |
|
inline |
Removes the visibility setting for adjacent edges.
|
inline |
Removes the visibility setting for cut edges.
|
inline |
Removes the visibility setting for cut faces.
|
inline |
Removes the visibility settings for both cut faces and cut edges.
|
inline |
Removes the visibility setting for cutting sections.
|
inline |
Removes the visibility setting for lighting of edges.
|
inline |
Removes the visibility settings for all edges.
|
inline |
Removes all visibility settings.
|
inline |
Removes the visibility setting for lighting of faces.
|
inline |
Removes the visibility setting for faces.
|
inline |
Removes the visibility setting for generic edges.
|
inline |
Removes the visibility settings for all edges, faces, lines, markers, and text.
|
inline |
Removes the visibility setting for hard edges.
|
inline |
Removes the visibility setting for interior silhouette edges.
|
inline |
Removes the visibility settings for all lights, including face, edge, and marker lights.
|
inline |
Removes the visibility setting for lines.
|
inline |
Removes the visibility setting for lighting or markers.
|
inline |
Removes the visibility setting for markers.
|
inline |
Removes the visibility setting for edges of mesh quads.
|
inline |
Removes the visibility setting for non-culled edges.
|
inline |
Removes the visibility setting for perimeter edges.
|
inline |
Removes the visibility setting for shadow casting.
|
inline |
Removes the visibility setting for shadow emitting.
|
inline |
Removes the visibility setting for shadow receiving.
|
inline |
Removes the visibility settings for shadow casting, emitting, and receiving.
|
inline |
Removes the visibility setting for text.
|
inline |
Removes the visibility setting for vertices.
|
inline |
Removes the visibility setting for windows.