
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.VisibilityKit in_kit) |
Check if the source VisibilityKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.VisibilityKit in_kit) |
Copies all settings from the source VisibilityKit into this object. 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 | 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 | SetCutGeometry (bool in_state) |
Sets the visibility of cut geometry, both cut faces and cut edges. More... | |
HPS.VisibilityKit | SetCuttingSections (bool in_state) |
Sets the visibility of cutting sections. More... | |
HPS.VisibilityKit | SetEdgeLights (bool in_state) |
Sets the visibility of lighting on edges. More... | |
HPS.VisibilityKit | SetEdges (bool in_state) |
Sets the visibility of all edges. More... | |
HPS.VisibilityKit | SetEverything (bool in_state) |
Sets the visibility of all geometry and subgeometry. More... | |
HPS.VisibilityKit | SetFaceLights (bool in_state) |
Sets the visibility of lighting on faces. More... | |
HPS.VisibilityKit | SetFaces (bool in_state) |
Sets the visibility of all faces, including shells, meshes, cylinders, etc.. More... | |
HPS.VisibilityKit | SetGenericEdges (bool in_state) |
Sets the visibility of generic edges. More... | |
HPS.VisibilityKit | SetGeometry (bool in_state) |
Sets the visibility of all edges, faces, lines, markers, and text. More... | |
HPS.VisibilityKit | SetHardEdges (bool in_state) |
Sets the visibility of hard edges. More... | |
HPS.VisibilityKit | SetInteriorSilhouetteEdges (bool in_state) |
Sets the visibility of interior silhouette edges. More... | |
HPS.VisibilityKit | SetLeaderLines (bool in_state) |
Sets the visibility of text leader lines. More... | |
HPS.VisibilityKit | SetLights (bool in_state) |
Sets the visibility of all lights, including face, edge, and marker lights. More... | |
HPS.VisibilityKit | SetLines (bool in_state) |
Sets the visibility of lines. More... | |
HPS.VisibilityKit | SetMarkerLights (bool in_state) |
Sets the visibility of lighting on markers. More... | |
HPS.VisibilityKit | SetMarkers (bool in_state) |
Sets the visibility of markers. 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 | SetShadowCasting (bool in_state) |
Sets the visibility of shadow casting. More... | |
HPS.VisibilityKit | SetShadowEmitting (bool in_state) |
Sets the visibility of shadow emitting. More... | |
HPS.VisibilityKit | SetShadowReceiving (bool in_state) |
Sets the visibility of shadow receiving. More... | |
HPS.VisibilityKit | SetShadows (bool in_state) |
Sets the visibility of shadow casting, emitting, and receiving. More... | |
HPS.VisibilityKit | SetText (bool in_state) |
Sets the visibility of text. More... | |
HPS.VisibilityKit | SetVertices (bool in_state) |
Sets the visibility of vertices. More... | |
HPS.VisibilityKit | SetWindows (bool in_state) |
Sets the visibility of windows. More... | |
void | Show (out HPS.VisibilityKit out_kit) |
Copies all settings from this VisibilityKit into the given VisibilityKit. More... | |
bool | ShowAdjacentEdges (out bool out_state) |
Shows the visibility setting for adjacent edges. 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 | ShowCuttingSections (out bool out_state) |
Shows the visibility setting for cutting sections. More... | |
bool | ShowEdgeLights (out bool out_state) |
Shows the visibility setting for lighting of edges. More... | |
bool | ShowFaceLights (out bool out_state) |
Shows the visibility setting for lighting of faces. More... | |
bool | ShowFaces (out bool out_state) |
Shows the visibility setting for faces. More... | |
bool | ShowGenericEdges (out bool out_state) |
Shows the visibility setting for generic edges. More... | |
bool | ShowHardEdges (out bool out_state) |
Shows the visibility setting for hard edges. More... | |
bool | ShowInteriorSilhouetteEdges (out bool out_state) |
Shows the visibility setting for silhouette edges. More... | |
bool | ShowLeaderLines (out bool out_state) |
Shows the visibility setting for text leader lines. More... | |
bool | ShowLines (out bool out_state) |
Shows the visibility setting for lines. More... | |
bool | ShowMarkerLights (out bool out_state) |
Shows the visibility setting for lighting of markers. More... | |
bool | ShowMarkers (out bool out_state) |
Shows the visibility setting for markers. 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 | ShowShadowCasting (out bool out_state) |
Shows the visibility setting for shadow casting. More... | |
bool | ShowShadowEmitting (out bool out_state) |
Shows the visibility setting for shadow emitting. More... | |
bool | ShowShadowReceiving (out bool out_state) |
Shows the visibility setting for shadow receiving. More... | |
bool | ShowText (out bool out_state) |
Shows the visibility setting for text. More... | |
bool | ShowVertices (out bool out_state) |
Shows the visibility setting for vertices. More... | |
bool | ShowWindows (out bool out_state) |
Shows the visibility setting for windows. More... | |
HPS.VisibilityKit | UnsetAdjacentEdges () |
Removes the visibility setting for adjacent edges. 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 | UnsetCutGeometry () |
Removes the visibility settings for both cut faces and cut edges. More... | |
HPS.VisibilityKit | UnsetCuttingSections () |
Removes the visibility setting for cutting sections. More... | |
HPS.VisibilityKit | UnsetEdgeLights () |
Removes the visibility setting for lighting of edges. More... | |
HPS.VisibilityKit | UnsetEdges () |
Removes the visibility settings for all edges. More... | |
HPS.VisibilityKit | UnsetEverything () |
Removes all visibility settings. More... | |
HPS.VisibilityKit | UnsetFaceLights () |
Removes the visibility setting for lighting of faces. More... | |
HPS.VisibilityKit | UnsetFaces () |
Removes the visibility setting for faces. More... | |
HPS.VisibilityKit | UnsetGenericEdges () |
Removes the visibility setting for generic edges. More... | |
HPS.VisibilityKit | UnsetGeometry () |
Removes the visibility settings for all edges, faces, lines, markers, and text. More... | |
HPS.VisibilityKit | UnsetHardEdges () |
Removes the visibility setting for hard edges. More... | |
HPS.VisibilityKit | UnsetInteriorSilhouetteEdges () |
Removes the visibility setting for interior silhouette edges. More... | |
HPS.VisibilityKit | UnsetLeaderLines () |
Removes the visibility settings for text leader lines. More... | |
HPS.VisibilityKit | UnsetLights () |
Removes the visibility settings for all lights, including face, edge, and marker lights. More... | |
HPS.VisibilityKit | UnsetLines () |
Removes the visibility setting for lines. More... | |
HPS.VisibilityKit | UnsetMarkerLights () |
Removes the visibility setting for lighting or markers. More... | |
HPS.VisibilityKit | UnsetMarkers () |
Removes the visibility setting for markers. 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 | UnsetShadowCasting () |
Removes the visibility setting for shadow casting. More... | |
HPS.VisibilityKit | UnsetShadowEmitting () |
Removes the visibility setting for shadow emitting. More... | |
HPS.VisibilityKit | UnsetShadowReceiving () |
Removes the visibility setting for shadow receiving. More... | |
HPS.VisibilityKit | UnsetShadows () |
Removes the visibility settings for shadow casting, emitting, and receiving. More... | |
HPS.VisibilityKit | UnsetText () |
Removes the visibility setting for text. More... | |
HPS.VisibilityKit | UnsetVertices () |
Removes the visibility setting for vertices. More... | |
HPS.VisibilityKit | UnsetWindows () |
Removes the visibility setting for windows. More... | |
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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override 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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. 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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
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.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
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.
|
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.
- Returns
- A VisibilityKit with the default settings.
|
inline |
Copies all settings from the source VisibilityKit into this object.
- Parameters
-
in_kit The source VisibilityKit 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.
- Parameters
-
in_state Whether adjacent edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of edges cut by a cutting sections.
- Parameters
-
in_state Whether cut edges are visible.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Sets the visibility of cutting sections.
- Parameters
-
in_state Whether cutting sections are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of lighting on edges.
- Parameters
-
in_state Whether edge lights are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of all edges.
- Parameters
-
in_state Whether all edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of all geometry and subgeometry.
- Parameters
-
in_state Whether everything is visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of lighting on faces.
- Parameters
-
in_state Whether face lights are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of all faces, including shells, meshes, cylinders, etc..
- Parameters
-
in_state Whether faces are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of generic edges.
- Parameters
-
in_state Whether generic edges are visible.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
Sets the visibility of hard edges.
- Parameters
-
in_state Whether hard edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of interior silhouette edges.
- Parameters
-
in_state Whether interior silhouette edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of text leader lines.
- Parameters
-
in_state Whether text leader lines are visible
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
Sets the visibility of lines.
- Parameters
-
in_state Whether lines are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of lighting on markers.
- Parameters
-
in_state Whether marker lights are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of markers.
- Parameters
-
in_state Whether markers are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of edges of mesh quads.
- Parameters
-
in_state Whether mesh quad edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of non-culled edges.
- Parameters
-
in_state Whether non-culled edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of perimeter edges.
- Parameters
-
in_state Whether perimeter edges are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of shadow casting.
- Parameters
-
in_state Whether casting shadows are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of shadow emitting.
- Parameters
-
in_state Whether emitting shadows are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of shadow receiving.
- Parameters
-
in_state Whether receiving shadows are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of shadow casting, emitting, and receiving.
- Parameters
-
in_state Whether all shadows are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of text.
- Parameters
-
in_state Whether text is visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of vertices.
- Parameters
-
in_state Whether vertices are visible.
- Returns
- A reference to this object.
|
inline |
Sets the visibility of windows.
- Parameters
-
in_state Whether windows are visible.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this VisibilityKit into the given VisibilityKit.
- Parameters
-
out_kit The VisibilityKit to populate with the contents of this object.
|
inline |
Shows the visibility setting for adjacent edges.
- Parameters
-
out_state Whether adjacent edges are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for cut edges.
- Parameters
-
out_state Whether cut edges are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for cut faces.
- Parameters
-
out_state Whether cut faces are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for cutting sections.
- Parameters
-
out_state Whether cutting sections are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the visibility setting for faces.
- Parameters
-
out_state Whether faces are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for generic edges.
- Parameters
-
out_state Whether generic edges are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for hard edges.
- Parameters
-
out_state Whether hard edges are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the visibility setting for lines.
- Parameters
-
out_state Whether lines are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
Shows the visibility setting for markers.
- Parameters
-
out_state Whether markers are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the visibility setting for perimeter edges.
- Parameters
-
out_state Whether perimeter edges are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for shadow casting.
- Parameters
-
out_state Whether casting shadows are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for shadow emitting.
- Parameters
-
out_state Whether emitting shadows are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for shadow receiving.
- Parameters
-
out_state Whether receiving shadows are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for text.
- Parameters
-
out_state Whether text is visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for vertices.
- Parameters
-
out_state Whether vertices are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the visibility setting for windows.
- Parameters
-
out_state Whether windows are visible.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes the visibility setting for adjacent edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for cut edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for cut faces.
- Returns
- A reference to this object.
|
inline |
Removes the visibility settings for both cut faces and cut edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for cutting sections.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for lighting of edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility settings for all edges.
- Returns
- A reference to this object.
|
inline |
Removes all visibility settings.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for lighting of faces.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for faces.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for generic edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility settings for all edges, faces, lines, markers, and text.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for hard edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for interior silhouette edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility settings for text leader lines.
- Returns
- A reference to this object.
|
inline |
Removes the visibility settings for all lights, including face, edge, and marker lights.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for lines.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for lighting or markers.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for markers.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for edges of mesh quads.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for non-culled edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for perimeter edges.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for shadow casting.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for shadow emitting.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for shadow receiving.
- Returns
- A reference to this object.
|
inline |
Removes the visibility settings for shadow casting, emitting, and receiving.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for text.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for vertices.
- Returns
- A reference to this object.
|
inline |
Removes the visibility setting for windows.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.VisibilityKit.cs