REFERENCE MANUAL
#include <hps.h>
Static Public Member Functions | |
static VisibilityKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The VisibilityKit class is a user space object, useful for carrying a group of attribute settings. Calling VisibilityKit::GetDefault() will return a kit with values found in this table.
VisibilityKit::VisibilityKit | ( | ) |
Initializes an empty kit.
VisibilityKit::VisibilityKit | ( | VisibilityKit const & | in_kit | ) |
The copy constructor creates a new VisibilityKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
VisibilityKit::VisibilityKit | ( | VisibilityKit && | in_that | ) |
The move constructor creates a VisibilityKit by transferring the underlying impl of the rvalue reference to this VisibilityKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a VisibilityKit to take the impl from. |
|
virtual |
Destroy this kit.
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from Object.
bool VisibilityKit::Equals | ( | VisibilityKit const & | in_kit | ) | const |
Check if the source VisibilityKit is equivalent to this object.
in_kit | The source VisibilityKit to compare to this object. |
|
static |
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 Object.
bool VisibilityKit::operator!= | ( | VisibilityKit const & | in_kit | ) | const |
Check if the source VisibilityKit is not equivalent to this object.
in_kit | The source VisibilityKit to compare to this object. |
VisibilityKit& VisibilityKit::operator= | ( | VisibilityKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this VisibilityKit thereby avoiding a copy.
in_that | An rvalue reference to a VisibilityKit to take the impl from. |
VisibilityKit& VisibilityKit::operator= | ( | VisibilityKit const & | in_kit | ) |
Copies the source VisibilityKit into this object.
in_kit | The source VisibilityKit to copy. |
bool VisibilityKit::operator== | ( | VisibilityKit const & | in_kit | ) | const |
Check if the source VisibilityKit is equivalent to this object.
in_kit | The source VisibilityKit to compare to this object. |
void VisibilityKit::Set | ( | VisibilityKit const & | in_kit | ) |
Copies all settings from the source VisibilityKit into this object.
in_kit | The source VisibilityKit to copy. |
VisibilityKit& VisibilityKit::SetAdjacentEdges | ( | bool | in_state | ) |
Sets the visibility of adjacent edges.
in_state | Whether adjacent edges are visible. |
VisibilityKit& VisibilityKit::SetCutEdges | ( | bool | in_state | ) |
Sets the visibility of edges cut by a cutting sections.
in_state | Whether cut edges are visible. |
VisibilityKit& VisibilityKit::SetCutFaces | ( | bool | in_state | ) |
Sets the visibility of capping planes for geometry cut by cutting sections.
in_state | Whether cut faces are visible. |
VisibilityKit& VisibilityKit::SetCutGeometry | ( | bool | in_state | ) |
Sets the visibility of cut geometry, both cut faces and cut edges.
in_state | Whether all cut geometry are visible. |
VisibilityKit& VisibilityKit::SetCuttingSections | ( | bool | in_state | ) |
Sets the visibility of cutting sections.
in_state | Whether cutting sections are visible. |
VisibilityKit& VisibilityKit::SetEdgeLights | ( | bool | in_state | ) |
Sets the visibility of lighting on edges.
in_state | Whether edge lights are visible. |
VisibilityKit& VisibilityKit::SetEdges | ( | bool | in_state | ) |
Sets the visibility of all edges.
in_state | Whether all edges are visible. |
VisibilityKit& VisibilityKit::SetEverything | ( | bool | in_state | ) |
Sets the visibility of all geometry and subgeometry.
in_state | Whether everything is visible. |
VisibilityKit& VisibilityKit::SetFaceLights | ( | bool | in_state | ) |
Sets the visibility of lighting on faces.
in_state | Whether face lights are visible. |
VisibilityKit& VisibilityKit::SetFaces | ( | bool | in_state | ) |
Sets the visibility of all faces, including shells, meshes, cylinders, etc..
in_state | Whether faces are visible. |
VisibilityKit& VisibilityKit::SetGenericEdges | ( | bool | in_state | ) |
Sets the visibility of generic edges.
in_state | Whether generic edges are visible. |
VisibilityKit& VisibilityKit::SetGeometry | ( | bool | in_state | ) |
Sets the visibility of all edges, faces, lines, markers, and text.
in_state | Whether all geometry is visible. |
VisibilityKit& VisibilityKit::SetHardEdges | ( | bool | in_state | ) |
Sets the visibility of hard edges.
in_state | Whether hard edges are visible. |
VisibilityKit& VisibilityKit::SetInteriorSilhouetteEdges | ( | bool | in_state | ) |
Sets the visibility of interior silhouette edges.
in_state | Whether interior silhouette edges are visible. |
VisibilityKit& VisibilityKit::SetLights | ( | bool | in_state | ) |
Sets the visibility of all lights, including face, edge, and marker lights.
in_state | Whether all lights are visible. |
VisibilityKit& VisibilityKit::SetLines | ( | bool | in_state | ) |
Sets the visibility of lines.
in_state | Whether lines are visible. |
VisibilityKit& VisibilityKit::SetMarkerLights | ( | bool | in_state | ) |
Sets the visibility of lighting on markers.
in_state | Whether marker lights are visible. |
VisibilityKit& VisibilityKit::SetMarkers | ( | bool | in_state | ) |
Sets the visibility of markers.
in_state | Whether markers are visible. |
VisibilityKit& VisibilityKit::SetMeshQuadEdges | ( | bool | in_state | ) |
Sets the visibility of edges of mesh quads.
in_state | Whether mesh quad edges are visible. |
VisibilityKit& VisibilityKit::SetNonCulledEdges | ( | bool | in_state | ) |
Sets the visibility of non-culled edges.
in_state | Whether non-culled edges are visible. |
VisibilityKit& VisibilityKit::SetPerimeterEdges | ( | bool | in_state | ) |
Sets the visibility of perimeter edges.
in_state | Whether perimeter edges are visible. |
VisibilityKit& VisibilityKit::SetShadowCasting | ( | bool | in_state | ) |
Sets the visibility of shadow casting.
in_state | Whether casting shadows are visible. |
VisibilityKit& VisibilityKit::SetShadowEmitting | ( | bool | in_state | ) |
Sets the visibility of shadow emitting.
in_state | Whether emitting shadows are visible. |
VisibilityKit& VisibilityKit::SetShadowReceiving | ( | bool | in_state | ) |
Sets the visibility of shadow receiving.
in_state | Whether receiving shadows are visible. |
VisibilityKit& VisibilityKit::SetShadows | ( | bool | in_state | ) |
Sets the visibility of shadow casting, emitting, and receiving.
in_state | Whether all shadows are visible. |
VisibilityKit& VisibilityKit::SetText | ( | bool | in_state | ) |
Sets the visibility of text.
in_state | Whether text is visible. |
VisibilityKit& VisibilityKit::SetVertices | ( | bool | in_state | ) |
Sets the visibility of vertices.
in_state | Whether vertices are visible. |
VisibilityKit& VisibilityKit::SetWindows | ( | bool | in_state | ) |
Sets the visibility of windows.
in_state | Whether windows are visible. |
void VisibilityKit::Show | ( | VisibilityKit & | out_kit | ) | const |
Copies all settings from this VisibilityKit into the given VisibilityKit.
out_kit | The VisibilityKit to populate with the contents of this object. |
bool VisibilityKit::ShowAdjacentEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for adjacent edges.
out_state | Whether adjacent edges are visible. |
bool VisibilityKit::ShowCutEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for cut edges.
out_state | Whether cut edges are visible. |
bool VisibilityKit::ShowCutFaces | ( | bool & | out_state | ) | const |
Shows the visibility setting for cut faces.
out_state | Whether cut faces are visible. |
bool VisibilityKit::ShowCuttingSections | ( | bool & | out_state | ) | const |
Shows the visibility setting for cutting sections.
out_state | Whether cutting sections are visible. |
bool VisibilityKit::ShowEdgeLights | ( | bool & | out_state | ) | const |
Shows the visibility setting for lighting of edges.
out_state | Whether edge lights are visible. |
bool VisibilityKit::ShowFaceLights | ( | bool & | out_state | ) | const |
Shows the visibility setting for lighting of faces.
out_state | Whether face lights are visible. |
bool VisibilityKit::ShowFaces | ( | bool & | out_state | ) | const |
Shows the visibility setting for faces.
out_state | Whether faces are visible. |
bool VisibilityKit::ShowGenericEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for generic edges.
out_state | Whether generic edges are visible. |
bool VisibilityKit::ShowHardEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for hard edges.
out_state | Whether hard edges are visible. |
bool VisibilityKit::ShowInteriorSilhouetteEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for silhouette edges.
out_state | Whether interior silhouette edges are visible. |
bool VisibilityKit::ShowLines | ( | bool & | out_state | ) | const |
Shows the visibility setting for lines.
out_state | Whether lines are visible. |
bool VisibilityKit::ShowMarkerLights | ( | bool & | out_state | ) | const |
Shows the visibility setting for lighting of markers.
out_state | Whether marker lights are visible. |
bool VisibilityKit::ShowMarkers | ( | bool & | out_state | ) | const |
Shows the visibility setting for markers.
out_state | Whether markers are visible. |
bool VisibilityKit::ShowMeshQuadEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for edges of mesh quads.
out_state | Whether mesh quad edges are visible. |
bool VisibilityKit::ShowNonCulledEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for non-culled edges.
out_state | Whether non-culled edges are visible. |
bool VisibilityKit::ShowPerimeterEdges | ( | bool & | out_state | ) | const |
Shows the visibility setting for perimeter edges.
out_state | Whether perimeter edges are visible. |
bool VisibilityKit::ShowShadowCasting | ( | bool & | out_state | ) | const |
Shows the visibility setting for shadow casting.
out_state | Whether casting shadows are visible. |
bool VisibilityKit::ShowShadowEmitting | ( | bool & | out_state | ) | const |
Shows the visibility setting for shadow emitting.
out_state | Whether emitting shadows are visible. |
bool VisibilityKit::ShowShadowReceiving | ( | bool & | out_state | ) | const |
Shows the visibility setting for shadow receiving.
out_state | Whether receiving shadows are visible. |
bool VisibilityKit::ShowText | ( | bool & | out_state | ) | const |
Shows the visibility setting for text.
out_state | Whether text is visible. |
bool VisibilityKit::ShowVertices | ( | bool & | out_state | ) | const |
Shows the visibility setting for vertices.
out_state | Whether vertices are visible. |
bool VisibilityKit::ShowWindows | ( | bool & | out_state | ) | const |
Shows the visibility setting for windows.
out_state | Whether windows are visible. |
VisibilityKit& VisibilityKit::UnsetAdjacentEdges | ( | ) |
Removes the visibility setting for adjacent edges.
VisibilityKit& VisibilityKit::UnsetCutEdges | ( | ) |
Removes the visibility setting for cut edges.
VisibilityKit& VisibilityKit::UnsetCutFaces | ( | ) |
Removes the visibility setting for cut faces.
VisibilityKit& VisibilityKit::UnsetCutGeometry | ( | ) |
Removes the visibility settings for both cut faces and cut edges.
VisibilityKit& VisibilityKit::UnsetCuttingSections | ( | ) |
Removes the visibility setting for cutting sections.
VisibilityKit& VisibilityKit::UnsetEdgeLights | ( | ) |
Removes the visibility setting for lighting of edges.
VisibilityKit& VisibilityKit::UnsetEdges | ( | ) |
Removes the visibility settings for all edges.
VisibilityKit& VisibilityKit::UnsetEverything | ( | ) |
Removes all visibility settings.
VisibilityKit& VisibilityKit::UnsetFaceLights | ( | ) |
Removes the visibility setting for lighting of faces.
VisibilityKit& VisibilityKit::UnsetFaces | ( | ) |
Removes the visibility setting for faces.
VisibilityKit& VisibilityKit::UnsetGenericEdges | ( | ) |
Removes the visibility setting for generic edges.
VisibilityKit& VisibilityKit::UnsetGeometry | ( | ) |
Removes the visibility settings for all edges, faces, lines, markers, and text.
VisibilityKit& VisibilityKit::UnsetHardEdges | ( | ) |
Removes the visibility setting for hard edges.
VisibilityKit& VisibilityKit::UnsetInteriorSilhouetteEdges | ( | ) |
Removes the visibility setting for interior silhouette edges.
VisibilityKit& VisibilityKit::UnsetLights | ( | ) |
Removes the visibility settings for all lights, including face, edge, and marker lights.
VisibilityKit& VisibilityKit::UnsetLines | ( | ) |
Removes the visibility setting for lines.
VisibilityKit& VisibilityKit::UnsetMarkerLights | ( | ) |
Removes the visibility setting for lighting or markers.
VisibilityKit& VisibilityKit::UnsetMarkers | ( | ) |
Removes the visibility setting for markers.
VisibilityKit& VisibilityKit::UnsetMeshQuadEdges | ( | ) |
Removes the visibility setting for edges of mesh quads.
VisibilityKit& VisibilityKit::UnsetNonCulledEdges | ( | ) |
Removes the visibility setting for non-culled edges.
VisibilityKit& VisibilityKit::UnsetPerimeterEdges | ( | ) |
Removes the visibility setting for perimeter edges.
VisibilityKit& VisibilityKit::UnsetShadowCasting | ( | ) |
Removes the visibility setting for shadow casting.
VisibilityKit& VisibilityKit::UnsetShadowEmitting | ( | ) |
Removes the visibility setting for shadow emitting.
VisibilityKit& VisibilityKit::UnsetShadowReceiving | ( | ) |
Removes the visibility setting for shadow receiving.
VisibilityKit& VisibilityKit::UnsetShadows | ( | ) |
Removes the visibility settings for shadow casting, emitting, and receiving.
VisibilityKit& VisibilityKit::UnsetText | ( | ) |
Removes the visibility setting for text.
VisibilityKit& VisibilityKit::UnsetVertices | ( | ) |
Removes the visibility setting for vertices.
VisibilityKit& VisibilityKit::UnsetWindows | ( | ) |
Removes the visibility setting for windows.