Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
HPS::VisibilityControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::VisibilityControl:
Inheritance graph
[legend]
Collaboration diagram for HPS::VisibilityControl:
Collaboration graph
[legend]

Public Member Functions

 VisibilityControl (SegmentKey &in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 VisibilityControl (VisibilityControl const &in_that)
 Initializes a control tied to the same object as in_that. More...
 
 VisibilityControl (VisibilityControl &&in_that)
 The move constructor creates a VisibilityControl by transferring the underlying impl of the rvalue reference to this VisibilityControl thereby avoiding a copy and allocation. More...
 
VisibilityControl & operator= (VisibilityControl &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this VisibilityControl thereby avoiding a copy. More...
 
 ~VisibilityControl ()
 Releases a reference to the database object this control is tied to. More...
 
virtual HPS::Type Type () const
 This function returns the true type of the underlying object. More...
 
HPS::Type ObjectType () const
 
VisibilityControl & operator= (VisibilityControl const &in_that)
 Share the underlying smart-pointer of the VisibilityControl source. More...
 
VisibilityControl & SetCuttingSections (bool in_state)
 Sets the visibility of cutting sections. More...
 
VisibilityControl & SetCutEdges (bool in_state)
 Sets the visibility of edges cut by a cutting sections. More...
 
VisibilityControl & SetCutFaces (bool in_state)
 Sets the visibility of capping planes for geometry cut by cutting sections. More...
 
VisibilityControl & SetWindows (bool in_state)
 Sets the visibility of windows. More...
 
VisibilityControl & SetText (bool in_state)
 Sets the visibility of text. More...
 
VisibilityControl & SetLines (bool in_state)
 Sets the visibility of lines. More...
 
VisibilityControl & SetEdgeLights (bool in_state)
 Sets the visibility of lighting on edges. More...
 
VisibilityControl & SetMarkerLights (bool in_state)
 Sets the visibility of lighting on markers and vertices. More...
 
VisibilityControl & SetFaceLights (bool in_state)
 Sets the visibility of lighting on faces. More...
 
VisibilityControl & SetGenericEdges (bool in_state)
 Sets the visibility of generic edges. More...
 
VisibilityControl & SetInteriorSilhouetteEdges (bool in_state)
 Sets the visibility of interior silhouette edges. More...
 
VisibilityControl & SetAdjacentEdges (bool in_state)
 Sets the visibility of adjacent edges. More...
 
VisibilityControl & SetHardEdges (bool in_state)
 Sets the visibility of hard edges. More...
 
VisibilityControl & SetMeshQuadEdges (bool in_state)
 Sets the visibility of edges of mesh quads. More...
 
VisibilityControl & SetNonCulledEdges (bool in_state)
 Sets the visibility of non-culled edges. More...
 
VisibilityControl & SetPerimeterEdges (bool in_state)
 Sets the visibility of perimeter edges. More...
 
VisibilityControl & SetFaces (bool in_state)
 Sets the visibility of all faces, including shells, meshes, cylinders, etc. More...
 
VisibilityControl & SetVertices (bool in_state)
 Sets the visibility of vertices. More...
 
VisibilityControl & SetMarkers (bool in_state)
 Sets the visibility of markers. More...
 
VisibilityControl & SetShadowCasting (bool in_state)
 Sets the visibility of shadow casting. More...
 
VisibilityControl & SetShadowReceiving (bool in_state)
 Sets the visibility of shadow receiving. More...
 
VisibilityControl & SetShadowEmitting (bool in_state)
 Sets the visibility of shadow emitting. More...
 
VisibilityControl & SetCutGeometry (bool in_state)
 Sets the visibility of cut geometry, both cut faces and cut edges. More...
 
VisibilityControl & SetEdges (bool in_state)
 Sets the visibility of all edges. More...
 
VisibilityControl & SetGeometry (bool in_state)
 Sets the visibility of all edges, faces, lines, markers, and text. More...
 
VisibilityControl & SetLights (bool in_state)
 Sets the visibility of all lights, including face, edge, and marker lights. More...
 
VisibilityControl & SetShadows (bool in_state)
 Sets the visibility of shadow casting, emitting, and receiving. More...
 
VisibilityControl & SetLeaderLines (bool in_state)
 Sets the visibility of text leader lines. More...
 
VisibilityControl & SetEverything (bool in_state)
 Sets the visibility of all geometry and subgeometry. More...
 
VisibilityControl & UnsetCuttingSections ()
 Removes the visibility setting for cutting sections. More...
 
VisibilityControl & UnsetCutEdges ()
 Removes the visibility setting for cut edges. More...
 
VisibilityControl & UnsetCutFaces ()
 Removes the visibility setting for cut faces. More...
 
VisibilityControl & UnsetWindows ()
 Removes the visibility setting for windows. More...
 
VisibilityControl & UnsetText ()
 Removes the visibility setting for text. More...
 
VisibilityControl & UnsetLines ()
 Removes the visibility setting for lines. More...
 
VisibilityControl & UnsetEdgeLights ()
 Removes the visibility setting for lighting of edges. More...
 
VisibilityControl & UnsetMarkerLights ()
 Removes the visibility setting for lighting or markers. More...
 
VisibilityControl & UnsetFaceLights ()
 Removes the visibility setting for lighting of faces. More...
 
VisibilityControl & UnsetGenericEdges ()
 Removes the visibility setting for generic edges. More...
 
VisibilityControl & UnsetInteriorSilhouetteEdges ()
 Removes the visibility setting for interior silhouette edges. More...
 
VisibilityControl & UnsetAdjacentEdges ()
 Removes the visibility setting for adjacent edges. More...
 
VisibilityControl & UnsetHardEdges ()
 Removes the visibility setting for hard edges. More...
 
VisibilityControl & UnsetMeshQuadEdges ()
 Removes the visibility setting for edges of mesh quads. More...
 
VisibilityControl & UnsetNonCulledEdges ()
 Removes the visibility setting for non-culled edges. More...
 
VisibilityControl & UnsetPerimeterEdges ()
 Removes the visibility setting for perimeter edges. More...
 
VisibilityControl & UnsetFaces ()
 Removes the visibility setting for faces. More...
 
VisibilityControl & UnsetVertices ()
 Removes the visibility setting for vertices. More...
 
VisibilityControl & UnsetMarkers ()
 Removes the visibility setting for markers. More...
 
VisibilityControl & UnsetShadowCasting ()
 Removes the visibility setting for shadow casting. More...
 
VisibilityControl & UnsetShadowReceiving ()
 Removes the visibility setting for shadow receiving. More...
 
VisibilityControl & UnsetShadowEmitting ()
 Removes the visibility setting for shadow emitting. More...
 
VisibilityControl & UnsetCutGeometry ()
 Removes the visibility settings for both cut faces and cut edges. More...
 
VisibilityControl & UnsetEdges ()
 Removes the visibility settings for all edges. More...
 
VisibilityControl & UnsetGeometry ()
 Removes the visibility settings for all edges, faces, lines, markers, and text. More...
 
VisibilityControl & UnsetLights ()
 Removes the visibility settings for all lights, including face, edge, and marker lights. More...
 
VisibilityControl & UnsetShadows ()
 Removes the visibility settings for shadow casting, emitting, and receiving. More...
 
VisibilityControl & UnsetLeaderLines ()
 Removes the visibility settings for text leader lines. More...
 
VisibilityControl & UnsetEverything ()
 Removes all visibility settings. More...
 
bool ShowCuttingSections (bool &out_state) const
 Shows the visibility setting for cutting sections. More...
 
bool ShowCutEdges (bool &out_state) const
 Shows the visibility setting for cut edges. More...
 
bool ShowCutFaces (bool &out_state) const
 Shows the visibility setting for cut faces. More...
 
bool ShowWindows (bool &out_state) const
 Shows the visibility setting for windows. More...
 
bool ShowText (bool &out_state) const
 Shows the visibility setting for text. More...
 
bool ShowLines (bool &out_state) const
 Shows the visibility setting for lines. More...
 
bool ShowEdgeLights (bool &out_state) const
 Shows the visibility setting for lighting of edges. More...
 
bool ShowMarkerLights (bool &out_state) const
 Shows the visibility setting for lighting of markers. More...
 
bool ShowFaceLights (bool &out_state) const
 Shows the visibility setting for lighting of faces. More...
 
bool ShowGenericEdges (bool &out_state) const
 Shows the visibility setting for generic edges. More...
 
bool ShowInteriorSilhouetteEdges (bool &out_state) const
 Shows the visibility setting for silhouette edges. More...
 
bool ShowAdjacentEdges (bool &out_state) const
 Shows the visibility setting for adjacent edges. More...
 
bool ShowHardEdges (bool &out_state) const
 Shows the visibility setting for hard edges. More...
 
bool ShowMeshQuadEdges (bool &out_state) const
 Shows the visibility setting for edges of mesh quads. More...
 
bool ShowNonCulledEdges (bool &out_state) const
 Shows the visibility setting for non-culled edges. More...
 
bool ShowPerimeterEdges (bool &out_state) const
 Shows the visibility setting for perimeter edges. More...
 
bool ShowFaces (bool &out_state) const
 Shows the visibility setting for faces. More...
 
bool ShowVertices (bool &out_state) const
 Shows the visibility setting for vertices. More...
 
bool ShowMarkers (bool &out_state) const
 Shows the visibility setting for markers. More...
 
bool ShowShadowCasting (bool &out_state) const
 Shows the visibility setting for shadow casting. More...
 
bool ShowShadowReceiving (bool &out_state) const
 Shows the visibility setting for shadow receiving. More...
 
bool ShowShadowEmitting (bool &out_state) const
 Shows the visibility setting for shadow emitting. More...
 
bool ShowLeaderLines (bool &out_state) const
 Shows the visibility setting for text leader lines. More...
 
virtual bool Empty () const
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS::Type in_mask) const
 This function indicates whether this Object has the given Type mask. More...
 
intptr_t GetClassID () const
 Returns a unique identifier that is shared by all objects of the same class. More...
 
intptr_t GetInstanceID () const
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 

Static Public Member Functions

template<typename T >
static intptr_t ClassID ()
 Unique identifier for this class. More...
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::VisibilityControl
 

Private Member Functions

 VisibilityControl ()
 Private default constructor to prevent instantiation without a segment. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ VisibilityControl() [1/4]

HPS::VisibilityControl::VisibilityControl ( SegmentKey &  in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ VisibilityControl() [2/4]

HPS::VisibilityControl::VisibilityControl ( VisibilityControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ VisibilityControl() [3/4]

HPS::VisibilityControl::VisibilityControl ( VisibilityControl &&  in_that)

The move constructor creates a VisibilityControl by transferring the underlying impl of the rvalue reference to this VisibilityControl thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a VisibilityControl to take the impl from.

◆ ~VisibilityControl()

HPS::VisibilityControl::~VisibilityControl ( )

Releases a reference to the database object this control is tied to.

◆ VisibilityControl() [4/4]

HPS::VisibilityControl::VisibilityControl ( )
private

Private default constructor to prevent instantiation without a segment.

Member Function Documentation

◆ ClassID()

template<typename T >
static intptr_t HPS::Object::ClassID ( )
inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

virtual bool HPS::Object::Empty ( ) const
inlinevirtualinherited

Indicates whether this object has any values set on it.

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const
inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns
A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const
inherited

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.

Returns
A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask) const
inherited

This function indicates whether this Object has the given Type mask.

Parameters
in_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::VisibilityControl::ObjectType ( ) const
inlinevirtual

Reimplemented from HPS::Control.

◆ operator=() [1/2]

VisibilityControl& HPS::VisibilityControl::operator= ( VisibilityControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this VisibilityControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a VisibilityControl to take the impl from.
Returns
A reference to this VisibilityControl.

◆ operator=() [2/2]

VisibilityControl& HPS::VisibilityControl::operator= ( VisibilityControl const &  in_that)

Share the underlying smart-pointer of the VisibilityControl source.

Parameters
in_thatThe VisibilityControl source of the assignment.
Returns
A reference to this VisibilityControl.

◆ Reset()

virtual void HPS::Object::Reset ( )
virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ SetAdjacentEdges()

VisibilityControl& HPS::VisibilityControl::SetAdjacentEdges ( bool  in_state)

Sets the visibility of adjacent edges.

Parameters
in_stateWhether adjacent edges are visible.
Returns
A reference to this object.

◆ SetCutEdges()

VisibilityControl& HPS::VisibilityControl::SetCutEdges ( bool  in_state)

Sets the visibility of edges cut by a cutting sections.

Parameters
in_stateWhether cut edges are visible.
Returns
A reference to this object.

◆ SetCutFaces()

VisibilityControl& HPS::VisibilityControl::SetCutFaces ( bool  in_state)

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

Parameters
in_stateWhether cut faces are visible.
Returns
A reference to this object.

◆ SetCutGeometry()

VisibilityControl& HPS::VisibilityControl::SetCutGeometry ( bool  in_state)

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

Parameters
in_stateWhether all cut geometry are visible.
Returns
A reference to this object.

◆ SetCuttingSections()

VisibilityControl& HPS::VisibilityControl::SetCuttingSections ( bool  in_state)

Sets the visibility of cutting sections.

Parameters
in_stateWhether cutting sections are visible.
Returns
A reference to this object.

◆ SetEdgeLights()

VisibilityControl& HPS::VisibilityControl::SetEdgeLights ( bool  in_state)

Sets the visibility of lighting on edges.

Parameters
in_stateWhether edge lights are visible.
Returns
A reference to this object.

◆ SetEdges()

VisibilityControl& HPS::VisibilityControl::SetEdges ( bool  in_state)

Sets the visibility of all edges.

Parameters
in_stateWhether all edges are visible.
Returns
A reference to this object.

◆ SetEverything()

VisibilityControl& HPS::VisibilityControl::SetEverything ( bool  in_state)

Sets the visibility of all geometry and subgeometry.

Parameters
in_stateWhether everything is visible.
Returns
A reference to this object.

◆ SetFaceLights()

VisibilityControl& HPS::VisibilityControl::SetFaceLights ( bool  in_state)

Sets the visibility of lighting on faces.

Parameters
in_stateWhether face lights are visible.
Returns
A reference to this object.

◆ SetFaces()

VisibilityControl& HPS::VisibilityControl::SetFaces ( bool  in_state)

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

Parameters
in_stateWhether faces are visible.
Returns
A reference to this object.

◆ SetGenericEdges()

VisibilityControl& HPS::VisibilityControl::SetGenericEdges ( bool  in_state)

Sets the visibility of generic edges.

Parameters
in_stateWhether generic edges are visible.
Returns
A reference to this object.

◆ SetGeometry()

VisibilityControl& HPS::VisibilityControl::SetGeometry ( bool  in_state)

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

Parameters
in_stateWhether all geometry is visible.
Returns
A reference to this object.

◆ SetHardEdges()

VisibilityControl& HPS::VisibilityControl::SetHardEdges ( bool  in_state)

Sets the visibility of hard edges.

Parameters
in_stateWhether hard edges are visible.
Returns
A reference to this object.

◆ SetInteriorSilhouetteEdges()

VisibilityControl& HPS::VisibilityControl::SetInteriorSilhouetteEdges ( bool  in_state)

Sets the visibility of interior silhouette edges.

Parameters
in_stateWhether interior silhouette edges are visible.
Returns
A reference to this object.

◆ SetLeaderLines()

VisibilityControl& HPS::VisibilityControl::SetLeaderLines ( bool  in_state)

Sets the visibility of text leader lines.

Parameters
in_stateWhether text leader lines are visible.
Returns
A reference to this object.

◆ SetLights()

VisibilityControl& HPS::VisibilityControl::SetLights ( bool  in_state)

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

Parameters
in_stateWhether all lights are visible.
Returns
A reference to this object.

◆ SetLines()

VisibilityControl& HPS::VisibilityControl::SetLines ( bool  in_state)

Sets the visibility of lines.

Parameters
in_stateWhether lines are visible.
Returns
A reference to this object.

◆ SetMarkerLights()

VisibilityControl& HPS::VisibilityControl::SetMarkerLights ( bool  in_state)

Sets the visibility of lighting on markers and vertices.

Parameters
in_stateWhether marker lights are visible.
Returns
A reference to this object.

◆ SetMarkers()

VisibilityControl& HPS::VisibilityControl::SetMarkers ( bool  in_state)

Sets the visibility of markers.

Parameters
in_stateWhether markers are visible.
Returns
A reference to this object.

◆ SetMeshQuadEdges()

VisibilityControl& HPS::VisibilityControl::SetMeshQuadEdges ( bool  in_state)

Sets the visibility of edges of mesh quads.

Parameters
in_stateWhether mesh quad edges are visible.
Returns
A reference to this object.

◆ SetNonCulledEdges()

VisibilityControl& HPS::VisibilityControl::SetNonCulledEdges ( bool  in_state)

Sets the visibility of non-culled edges.

Parameters
in_stateWhether non-culled edges are visible.
Returns
A reference to this object.

◆ SetPerimeterEdges()

VisibilityControl& HPS::VisibilityControl::SetPerimeterEdges ( bool  in_state)

Sets the visibility of perimeter edges.

Parameters
in_stateWhether perimeter edges are visible.
Returns
A reference to this object.

◆ SetShadowCasting()

VisibilityControl& HPS::VisibilityControl::SetShadowCasting ( bool  in_state)

Sets the visibility of shadow casting.

Parameters
in_stateWhether casting shadows are visible.
Returns
A reference to this object.

◆ SetShadowEmitting()

VisibilityControl& HPS::VisibilityControl::SetShadowEmitting ( bool  in_state)

Sets the visibility of shadow emitting.

Parameters
in_stateWhether emitting shadows are visible.
Returns
A reference to this object.

◆ SetShadowReceiving()

VisibilityControl& HPS::VisibilityControl::SetShadowReceiving ( bool  in_state)

Sets the visibility of shadow receiving.

Parameters
in_stateWhether receiving shadows are visible.
Returns
A reference to this object.

◆ SetShadows()

VisibilityControl& HPS::VisibilityControl::SetShadows ( bool  in_state)

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

Parameters
in_stateWhether all shadows are visible.
Returns
A reference to this object.

◆ SetText()

VisibilityControl& HPS::VisibilityControl::SetText ( bool  in_state)

Sets the visibility of text.

Parameters
in_stateWhether text is visible.
Returns
A reference to this object.

◆ SetVertices()

VisibilityControl& HPS::VisibilityControl::SetVertices ( bool  in_state)

Sets the visibility of vertices.

Parameters
in_stateWhether vertices are visible.
Returns
A reference to this object.

◆ SetWindows()

VisibilityControl& HPS::VisibilityControl::SetWindows ( bool  in_state)

Sets the visibility of windows.

Parameters
in_stateWhether windows are visible.
Returns
A reference to this object.

◆ ShowAdjacentEdges()

bool HPS::VisibilityControl::ShowAdjacentEdges ( bool &  out_state) const

Shows the visibility setting for adjacent edges.

Parameters
out_stateWhether adjacent edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowCutEdges()

bool HPS::VisibilityControl::ShowCutEdges ( bool &  out_state) const

Shows the visibility setting for cut edges.

Parameters
out_stateWhether cut edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowCutFaces()

bool HPS::VisibilityControl::ShowCutFaces ( bool &  out_state) const

Shows the visibility setting for cut faces.

Parameters
out_stateWhether cut faces are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowCuttingSections()

bool HPS::VisibilityControl::ShowCuttingSections ( bool &  out_state) const

Shows the visibility setting for cutting sections.

Parameters
out_stateWhether cutting sections are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowEdgeLights()

bool HPS::VisibilityControl::ShowEdgeLights ( bool &  out_state) const

Shows the visibility setting for lighting of edges.

Parameters
out_stateWhether edge lights are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowFaceLights()

bool HPS::VisibilityControl::ShowFaceLights ( bool &  out_state) const

Shows the visibility setting for lighting of faces.

Parameters
out_stateWhether face lights are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowFaces()

bool HPS::VisibilityControl::ShowFaces ( bool &  out_state) const

Shows the visibility setting for faces.

Parameters
out_stateWhether faces are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowGenericEdges()

bool HPS::VisibilityControl::ShowGenericEdges ( bool &  out_state) const

Shows the visibility setting for generic edges.

Parameters
out_stateWhether generic edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowHardEdges()

bool HPS::VisibilityControl::ShowHardEdges ( bool &  out_state) const

Shows the visibility setting for hard edges.

Parameters
out_stateWhether hard edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowInteriorSilhouetteEdges()

bool HPS::VisibilityControl::ShowInteriorSilhouetteEdges ( bool &  out_state) const

Shows the visibility setting for silhouette edges.

Parameters
out_stateWhether interior silhouette edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowLeaderLines()

bool HPS::VisibilityControl::ShowLeaderLines ( bool &  out_state) const

Shows the visibility setting for text leader lines.

Parameters
out_stateWhether text leader lines are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowLines()

bool HPS::VisibilityControl::ShowLines ( bool &  out_state) const

Shows the visibility setting for lines.

Parameters
out_stateWhether lines are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowMarkerLights()

bool HPS::VisibilityControl::ShowMarkerLights ( bool &  out_state) const

Shows the visibility setting for lighting of markers.

Parameters
out_stateWhether marker lights are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowMarkers()

bool HPS::VisibilityControl::ShowMarkers ( bool &  out_state) const

Shows the visibility setting for markers.

Parameters
out_stateWhether markers are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowMeshQuadEdges()

bool HPS::VisibilityControl::ShowMeshQuadEdges ( bool &  out_state) const

Shows the visibility setting for edges of mesh quads.

Parameters
out_stateWhether mesh quad edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowNonCulledEdges()

bool HPS::VisibilityControl::ShowNonCulledEdges ( bool &  out_state) const

Shows the visibility setting for non-culled edges.

Parameters
out_stateWhether non-culled edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowPerimeterEdges()

bool HPS::VisibilityControl::ShowPerimeterEdges ( bool &  out_state) const

Shows the visibility setting for perimeter edges.

Parameters
out_stateWhether perimeter edges are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowShadowCasting()

bool HPS::VisibilityControl::ShowShadowCasting ( bool &  out_state) const

Shows the visibility setting for shadow casting.

Parameters
out_stateWhether casting shadows are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowShadowEmitting()

bool HPS::VisibilityControl::ShowShadowEmitting ( bool &  out_state) const

Shows the visibility setting for shadow emitting.

Parameters
out_stateWhether emitting shadows are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowShadowReceiving()

bool HPS::VisibilityControl::ShowShadowReceiving ( bool &  out_state) const

Shows the visibility setting for shadow receiving.

Parameters
out_stateWhether receiving shadows are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowText()

bool HPS::VisibilityControl::ShowText ( bool &  out_state) const

Shows the visibility setting for text.

Parameters
out_stateWhether text is visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowVertices()

bool HPS::VisibilityControl::ShowVertices ( bool &  out_state) const

Shows the visibility setting for vertices.

Parameters
out_stateWhether vertices are visible.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindows()

bool HPS::VisibilityControl::ShowWindows ( bool &  out_state) const

Shows the visibility setting for windows.

Parameters
out_stateWhether windows are visible.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::VisibilityControl::Type ( ) const
inlinevirtual

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.

Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetAdjacentEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetCutEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetCutFaces()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetCutGeometry()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetCuttingSections()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetEdgeLights()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetEverything()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetFaceLights()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetFaces()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetGenericEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetGeometry()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetHardEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetInteriorSilhouetteEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetLeaderLines()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetLights()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetLines()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetMarkerLights()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetMarkers()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetMeshQuadEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetNonCulledEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetPerimeterEdges()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetShadowCasting()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetShadowEmitting()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetShadowReceiving()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetShadows()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetText()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetVertices()

VisibilityControl& 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().

Returns
A reference to this object.

◆ UnsetWindows()

VisibilityControl& 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().

Returns
A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::VisibilityControl::staticType = HPS::Type::VisibilityControl
static
The documentation for this class was generated from the following file: