The HPS::VisibilityKit class is a user space object, useful for carrying a group of attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::VisibilityKit:

Collaboration diagram for HPS::VisibilityKit:

Public Member Functions
	VisibilityKit ()
	Initializes an empty kit. More...

	VisibilityKit (VisibilityKit const &in_kit)
	The copy constructor creates a new VisibilityKit object that contains the same settings as the source object. More...

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

VisibilityKit &	operator= (VisibilityKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this VisibilityKit thereby avoiding a copy. More...

virtual	~VisibilityKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (VisibilityKit const &in_kit)
	Copies all settings from the source VisibilityKit into this object. More...

void	Show (VisibilityKit &out_kit) const
	Copies all settings from this VisibilityKit into the given VisibilityKit. More...

VisibilityKit &	operator= (VisibilityKit const &in_kit)
	Copies the source VisibilityKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (VisibilityKit const &in_kit) const
	Check if the source VisibilityKit is equivalent to this object. More...

bool	operator== (VisibilityKit const &in_kit) const
	Check if the source VisibilityKit is equivalent to this object. More...

bool	operator!= (VisibilityKit const &in_kit) const
	Check if the source VisibilityKit is not equivalent to this object. More...

VisibilityKit &	SetCuttingSections (bool in_state)
	Sets the visibility of cutting sections. More...

VisibilityKit &	SetCutEdges (bool in_state)
	Sets the visibility of edges cut by a cutting sections. More...

VisibilityKit &	SetCutFaces (bool in_state)
	Sets the visibility of capping planes for geometry cut by cutting sections. More...

VisibilityKit &	SetWindows (bool in_state)
	Sets the visibility of windows. More...

VisibilityKit &	SetText (bool in_state)
	Sets the visibility of text. More...

VisibilityKit &	SetLines (bool in_state)
	Sets the visibility of lines. More...

VisibilityKit &	SetEdgeLights (bool in_state)
	Sets the visibility of lighting on edges. More...

VisibilityKit &	SetMarkerLights (bool in_state)
	Sets the visibility of lighting on markers. More...

VisibilityKit &	SetFaceLights (bool in_state)
	Sets the visibility of lighting on faces. More...

VisibilityKit &	SetGenericEdges (bool in_state)
	Sets the visibility of generic edges. More...

VisibilityKit &	SetInteriorSilhouetteEdges (bool in_state)
	Sets the visibility of interior silhouette edges. More...

VisibilityKit &	SetAdjacentEdges (bool in_state)
	Sets the visibility of adjacent edges. More...

VisibilityKit &	SetHardEdges (bool in_state)
	Sets the visibility of hard edges. More...

VisibilityKit &	SetMeshQuadEdges (bool in_state)
	Sets the visibility of edges of mesh quads. More...

VisibilityKit &	SetNonCulledEdges (bool in_state)
	Sets the visibility of non-culled edges. More...

VisibilityKit &	SetPerimeterEdges (bool in_state)
	Sets the visibility of perimeter edges. More...

VisibilityKit &	SetFaces (bool in_state)
	Sets the visibility of all faces, including shells, meshes, cylinders, etc. More...

VisibilityKit &	SetVertices (bool in_state)
	Sets the visibility of vertices. More...

VisibilityKit &	SetMarkers (bool in_state)
	Sets the visibility of markers. More...

VisibilityKit &	SetShadowCasting (bool in_state)
	Sets the visibility of shadow casting. More...

VisibilityKit &	SetShadowReceiving (bool in_state)
	Sets the visibility of shadow receiving. More...

VisibilityKit &	SetShadowEmitting (bool in_state)
	Sets the visibility of shadow emitting. More...

VisibilityKit &	SetCutGeometry (bool in_state)
	Sets the visibility of cut geometry, both cut faces and cut edges. More...

VisibilityKit &	SetEdges (bool in_state)
	Sets the visibility of all edges. More...

VisibilityKit &	SetGeometry (bool in_state)
	Sets the visibility of all edges, faces, lines, markers, and text. More...

VisibilityKit &	SetLights (bool in_state)
	Sets the visibility of all lights, including face, edge, and marker lights. More...

VisibilityKit &	SetShadows (bool in_state)
	Sets the visibility of shadow casting, emitting, and receiving. More...

VisibilityKit &	SetLeaderLines (bool in_state)
	Sets the visibility of text leader lines. More...

VisibilityKit &	SetEverything (bool in_state)
	Sets the visibility of all geometry and subgeometry. More...

VisibilityKit &	UnsetCuttingSections ()
	Removes the visibility setting for cutting sections. More...

VisibilityKit &	UnsetCutEdges ()
	Removes the visibility setting for cut edges. More...

VisibilityKit &	UnsetCutFaces ()
	Removes the visibility setting for cut faces. More...

VisibilityKit &	UnsetWindows ()
	Removes the visibility setting for windows. More...

VisibilityKit &	UnsetText ()
	Removes the visibility setting for text. More...

VisibilityKit &	UnsetLines ()
	Removes the visibility setting for lines. More...

VisibilityKit &	UnsetEdgeLights ()
	Removes the visibility setting for lighting of edges. More...

VisibilityKit &	UnsetMarkerLights ()
	Removes the visibility setting for lighting or markers. More...

VisibilityKit &	UnsetFaceLights ()
	Removes the visibility setting for lighting of faces. More...

VisibilityKit &	UnsetGenericEdges ()
	Removes the visibility setting for generic edges. More...

VisibilityKit &	UnsetInteriorSilhouetteEdges ()
	Removes the visibility setting for interior silhouette edges. More...

VisibilityKit &	UnsetAdjacentEdges ()
	Removes the visibility setting for adjacent edges. More...

VisibilityKit &	UnsetHardEdges ()
	Removes the visibility setting for hard edges. More...

VisibilityKit &	UnsetMeshQuadEdges ()
	Removes the visibility setting for edges of mesh quads. More...

VisibilityKit &	UnsetNonCulledEdges ()
	Removes the visibility setting for non-culled edges. More...

VisibilityKit &	UnsetPerimeterEdges ()
	Removes the visibility setting for perimeter edges. More...

VisibilityKit &	UnsetFaces ()
	Removes the visibility setting for faces. More...

VisibilityKit &	UnsetVertices ()
	Removes the visibility setting for vertices. More...

VisibilityKit &	UnsetMarkers ()
	Removes the visibility setting for markers. More...

VisibilityKit &	UnsetShadowCasting ()
	Removes the visibility setting for shadow casting. More...

VisibilityKit &	UnsetShadowReceiving ()
	Removes the visibility setting for shadow receiving. More...

VisibilityKit &	UnsetShadowEmitting ()
	Removes the visibility setting for shadow emitting. More...

VisibilityKit &	UnsetCutGeometry ()
	Removes the visibility settings for both cut faces and cut edges. More...

VisibilityKit &	UnsetEdges ()
	Removes the visibility settings for all edges. More...

VisibilityKit &	UnsetGeometry ()
	Removes the visibility settings for all edges, faces, lines, markers, and text. More...

VisibilityKit &	UnsetLights ()
	Removes the visibility settings for all lights, including face, edge, and marker lights. More...

VisibilityKit &	UnsetShadows ()
	Removes the visibility settings for shadow casting, emitting, and receiving. More...

VisibilityKit &	UnsetLeaderLines ()
	Removes the visibility settings for text leader lines. More...

VisibilityKit &	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 HPS::Type	Type () const
	This function returns the true type of the underlying object. 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
static VisibilityKit	GetDefault ()
	Creates a VisibilityKit which contains the default settings. More...

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

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::VisibilityKit

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

◆ VisibilityKit() [1/3]

HPS::VisibilityKit::VisibilityKit ( )

Initializes an empty kit.

◆ VisibilityKit() [2/3]

HPS::VisibilityKit::VisibilityKit ( VisibilityKit const & in_kit )

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.

◆ VisibilityKit() [3/3]

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

Parameters

in_that An rvalue reference to a VisibilityKit to take the impl from.

◆ ~VisibilityKit()

virtual HPS::VisibilityKit::~VisibilityKit ( )

virtual

Destroy this kit.

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()

bool HPS::VisibilityKit::Empty ( ) const

virtual

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.

◆ Equals()

bool HPS::VisibilityKit::Equals ( VisibilityKit const & in_kit ) const

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.

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

◆ GetDefault()

static VisibilityKit HPS::VisibilityKit::GetDefault ( )

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.

Returns: A VisibilityKit with the default settings.

◆ 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_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::VisibilityKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::VisibilityKit::operator!= ( VisibilityKit const & in_kit ) const

Check if the source VisibilityKit is not equivalent to this object.

Parameters

in_kit The source VisibilityKit to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a VisibilityKit to take the impl from.

Returns: A reference to this VisibilityKit.

◆ operator=() [2/2]

VisibilityKit& HPS::VisibilityKit::operator= ( VisibilityKit const & in_kit )

Copies the source VisibilityKit into this object.

Parameters

in_kit The source VisibilityKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::VisibilityKit::operator== ( VisibilityKit const & in_kit ) const

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.

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

◆ Set()

void HPS::VisibilityKit::Set ( VisibilityKit const & in_kit )

Copies all settings from the source VisibilityKit into this object.

Parameters

in_kit The source VisibilityKit to copy.

◆ SetAdjacentEdges()

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

Parameters

in_state Whether adjacent edges are visible.

Returns: A reference to this object.

◆ SetCutEdges()

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

Sets the visibility of edges cut by a cutting sections.

Parameters

in_state Whether cut edges are visible.

Returns: A reference to this object.

◆ SetCutFaces()

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

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.

◆ SetCutGeometry()

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

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.

◆ SetCuttingSections()

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

Sets the visibility of cutting sections.

Parameters

in_state Whether cutting sections are visible.

Returns: A reference to this object.

◆ SetEdgeLights()

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

Sets the visibility of lighting on edges.

Parameters

in_state Whether edge lights are visible.

Returns: A reference to this object.

◆ SetEdges()

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

Sets the visibility of all edges.

Parameters

in_state Whether all edges are visible.

Returns: A reference to this object.

◆ SetEverything()

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

Sets the visibility of all geometry and subgeometry.

Parameters

in_state Whether everything is visible.

Returns: A reference to this object.

◆ SetFaceLights()

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

Sets the visibility of lighting on faces.

Parameters

in_state Whether face lights are visible.

Returns: A reference to this object.

◆ SetFaces()

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

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

Parameters

in_state Whether faces are visible.

Returns: A reference to this object.

◆ SetGenericEdges()

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

Sets the visibility of generic edges.

Parameters

in_state Whether generic edges are visible.

Returns: A reference to this object.

◆ SetGeometry()

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

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.

◆ SetHardEdges()

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

Sets the visibility of hard edges.

Parameters

in_state Whether hard edges are visible.

Returns: A reference to this object.

◆ SetInteriorSilhouetteEdges()

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

Sets the visibility of interior silhouette edges.

Parameters

in_state Whether interior silhouette edges are visible.

Returns: A reference to this object.

◆ SetLeaderLines()

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

Sets the visibility of text leader lines.

Parameters

in_state Whether text leader lines are visible

Returns: A reference to this object.

◆ SetLights()

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

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.

◆ SetLines()

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

Sets the visibility of lines.

Parameters

in_state Whether lines are visible.

Returns: A reference to this object.

◆ SetMarkerLights()

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

Sets the visibility of lighting on markers.

Parameters

in_state Whether marker lights are visible.

Returns: A reference to this object.

◆ SetMarkers()

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

Sets the visibility of markers.

Parameters

in_state Whether markers are visible.

Returns: A reference to this object.

◆ SetMeshQuadEdges()

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

Sets the visibility of edges of mesh quads.

Parameters

in_state Whether mesh quad edges are visible.

Returns: A reference to this object.

◆ SetNonCulledEdges()

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

Sets the visibility of non-culled edges.

Parameters

in_state Whether non-culled edges are visible.

Returns: A reference to this object.

◆ SetPerimeterEdges()

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

Sets the visibility of perimeter edges.

Parameters

in_state Whether perimeter edges are visible.

Returns: A reference to this object.

◆ SetShadowCasting()

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

Sets the visibility of shadow casting.

Parameters

in_state Whether casting shadows are visible.

Returns: A reference to this object.

◆ SetShadowEmitting()

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

Sets the visibility of shadow emitting.

Parameters

in_state Whether emitting shadows are visible.

Returns: A reference to this object.

◆ SetShadowReceiving()

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

Sets the visibility of shadow receiving.

Parameters

in_state Whether receiving shadows are visible.

Returns: A reference to this object.

◆ SetShadows()

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

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

Parameters

in_state Whether all shadows are visible.

Returns: A reference to this object.

◆ SetText()

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

Sets the visibility of text.

Parameters

in_state Whether text is visible.

Returns: A reference to this object.

◆ SetVertices()

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

Sets the visibility of vertices.

Parameters

in_state Whether vertices are visible.

Returns: A reference to this object.

◆ SetWindows()

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

Sets the visibility of windows.

Parameters

in_state Whether windows are visible.

Returns: A reference to this object.

◆ Show()

void HPS::VisibilityKit::Show ( VisibilityKit & out_kit ) const

Copies all settings from this VisibilityKit into the given VisibilityKit.

Parameters

out_kit The VisibilityKit to populate with the contents of this object.

◆ ShowAdjacentEdges()

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

Shows the visibility setting for adjacent edges.

Parameters

out_state Whether adjacent edges are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowCutEdges()

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

Shows the visibility setting for cut edges.

Parameters

out_state Whether cut edges are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowCutFaces()

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

Shows the visibility setting for cut faces.

Parameters

out_state Whether cut faces are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowCuttingSections()

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

Shows the visibility setting for cutting sections.

Parameters

out_state Whether cutting sections are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowEdgeLights()

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

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.

◆ ShowFaceLights()

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

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.

◆ ShowFaces()

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

Shows the visibility setting for faces.

Parameters

out_state Whether faces are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowGenericEdges()

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

Shows the visibility setting for generic edges.

Parameters

out_state Whether generic edges are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowHardEdges()

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

Shows the visibility setting for hard edges.

Parameters

out_state Whether hard edges are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowInteriorSilhouetteEdges()

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

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.

◆ ShowLeaderLines()

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

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.

◆ ShowLines()

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

Shows the visibility setting for lines.

Parameters

out_state Whether lines are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowMarkerLights()

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

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.

◆ ShowMarkers()

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

Shows the visibility setting for markers.

Parameters

out_state Whether markers are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowMeshQuadEdges()

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

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.

◆ ShowNonCulledEdges()

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

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.

◆ ShowPerimeterEdges()

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

Shows the visibility setting for perimeter edges.

Parameters

out_state Whether perimeter edges are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowShadowCasting()

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

Shows the visibility setting for shadow casting.

Parameters

out_state Whether casting shadows are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowShadowEmitting()

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

Shows the visibility setting for shadow emitting.

Parameters

out_state Whether emitting shadows are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowShadowReceiving()

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

Shows the visibility setting for shadow receiving.

Parameters

out_state Whether receiving shadows are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowText()

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

Shows the visibility setting for text.

Parameters

out_state Whether text is visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowVertices()

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

Shows the visibility setting for vertices.

Parameters

out_state Whether vertices are visible.

Returns: true if the setting is valid, false otherwise.

◆ ShowWindows()

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

Shows the visibility setting for windows.

Parameters

out_state Whether windows are visible.

Returns: true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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::Object.

◆ UnsetAdjacentEdges()

VisibilityKit& HPS::VisibilityKit::UnsetAdjacentEdges ( )

Removes the visibility setting for adjacent edges.

Returns: A reference to this object.

◆ UnsetCutEdges()

VisibilityKit& HPS::VisibilityKit::UnsetCutEdges ( )

Removes the visibility setting for cut edges.

Returns: A reference to this object.

◆ UnsetCutFaces()

VisibilityKit& HPS::VisibilityKit::UnsetCutFaces ( )

Removes the visibility setting for cut faces.

Returns: A reference to this object.

◆ UnsetCutGeometry()

VisibilityKit& HPS::VisibilityKit::UnsetCutGeometry ( )

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

Returns: A reference to this object.

◆ UnsetCuttingSections()

VisibilityKit& HPS::VisibilityKit::UnsetCuttingSections ( )

Removes the visibility setting for cutting sections.

Returns: A reference to this object.

◆ UnsetEdgeLights()

VisibilityKit& HPS::VisibilityKit::UnsetEdgeLights ( )

Removes the visibility setting for lighting of edges.

Returns: A reference to this object.

◆ UnsetEdges()

VisibilityKit& HPS::VisibilityKit::UnsetEdges ( )

Removes the visibility settings for all edges.

Returns: A reference to this object.

◆ UnsetEverything()

VisibilityKit& HPS::VisibilityKit::UnsetEverything ( )

Removes all visibility settings.

Returns: A reference to this object.

◆ UnsetFaceLights()

VisibilityKit& HPS::VisibilityKit::UnsetFaceLights ( )

Removes the visibility setting for lighting of faces.

Returns: A reference to this object.

◆ UnsetFaces()

VisibilityKit& HPS::VisibilityKit::UnsetFaces ( )

Removes the visibility setting for faces.

Returns: A reference to this object.

◆ UnsetGenericEdges()

VisibilityKit& HPS::VisibilityKit::UnsetGenericEdges ( )

Removes the visibility setting for generic edges.

Returns: A reference to this object.

◆ UnsetGeometry()

VisibilityKit& HPS::VisibilityKit::UnsetGeometry ( )

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

Returns: A reference to this object.

◆ UnsetHardEdges()

VisibilityKit& HPS::VisibilityKit::UnsetHardEdges ( )

Removes the visibility setting for hard edges.

Returns: A reference to this object.

◆ UnsetInteriorSilhouetteEdges()

VisibilityKit& HPS::VisibilityKit::UnsetInteriorSilhouetteEdges ( )

Removes the visibility setting for interior silhouette edges.

Returns: A reference to this object.

◆ UnsetLeaderLines()

VisibilityKit& HPS::VisibilityKit::UnsetLeaderLines ( )

Removes the visibility settings for text leader lines.

Returns: A reference to this object.

◆ UnsetLights()

VisibilityKit& HPS::VisibilityKit::UnsetLights ( )

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

Returns: A reference to this object.

◆ UnsetLines()

VisibilityKit& HPS::VisibilityKit::UnsetLines ( )

Removes the visibility setting for lines.

Returns: A reference to this object.

◆ UnsetMarkerLights()

VisibilityKit& HPS::VisibilityKit::UnsetMarkerLights ( )

Removes the visibility setting for lighting or markers.

Returns: A reference to this object.

◆ UnsetMarkers()

VisibilityKit& HPS::VisibilityKit::UnsetMarkers ( )

Removes the visibility setting for markers.

Returns: A reference to this object.

◆ UnsetMeshQuadEdges()

VisibilityKit& HPS::VisibilityKit::UnsetMeshQuadEdges ( )

Removes the visibility setting for edges of mesh quads.

Returns: A reference to this object.

◆ UnsetNonCulledEdges()

VisibilityKit& HPS::VisibilityKit::UnsetNonCulledEdges ( )

Removes the visibility setting for non-culled edges.

Returns: A reference to this object.

◆ UnsetPerimeterEdges()

VisibilityKit& HPS::VisibilityKit::UnsetPerimeterEdges ( )

Removes the visibility setting for perimeter edges.

Returns: A reference to this object.

◆ UnsetShadowCasting()

VisibilityKit& HPS::VisibilityKit::UnsetShadowCasting ( )

Removes the visibility setting for shadow casting.

Returns: A reference to this object.

◆ UnsetShadowEmitting()

VisibilityKit& HPS::VisibilityKit::UnsetShadowEmitting ( )

Removes the visibility setting for shadow emitting.

Returns: A reference to this object.

◆ UnsetShadowReceiving()

VisibilityKit& HPS::VisibilityKit::UnsetShadowReceiving ( )

Removes the visibility setting for shadow receiving.

Returns: A reference to this object.

◆ UnsetShadows()

VisibilityKit& HPS::VisibilityKit::UnsetShadows ( )

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

Returns: A reference to this object.

◆ UnsetText()

VisibilityKit& HPS::VisibilityKit::UnsetText ( )

Removes the visibility setting for text.

Returns: A reference to this object.

◆ UnsetVertices()

VisibilityKit& HPS::VisibilityKit::UnsetVertices ( )

Removes the visibility setting for vertices.

Returns: A reference to this object.

◆ UnsetWindows()

VisibilityKit& HPS::VisibilityKit::UnsetWindows ( )

Removes the visibility setting for windows.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::VisibilityKit::staticType = HPS::Type::VisibilityKit

static

The documentation for this class was generated from the following file:

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VisibilityKit() [1/3]

◆ VisibilityKit() [2/3]

◆ VisibilityKit() [3/3]

◆ ~VisibilityKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAdjacentEdges()

◆ SetCutEdges()

◆ SetCutFaces()

◆ SetCutGeometry()

◆ SetCuttingSections()

◆ SetEdgeLights()

◆ SetEdges()

◆ SetEverything()

◆ SetFaceLights()

◆ SetFaces()

◆ SetGenericEdges()

◆ SetGeometry()

◆ SetHardEdges()

◆ SetInteriorSilhouetteEdges()

◆ SetLeaderLines()

◆ SetLights()

◆ SetLines()

◆ SetMarkerLights()

◆ SetMarkers()

◆ SetMeshQuadEdges()

◆ SetNonCulledEdges()

◆ SetPerimeterEdges()

◆ SetShadowCasting()

◆ SetShadowEmitting()

◆ SetShadowReceiving()

◆ SetShadows()

◆ SetText()

◆ SetVertices()

◆ SetWindows()

◆ Show()

◆ ShowAdjacentEdges()

◆ ShowCutEdges()

◆ ShowCutFaces()

◆ ShowCuttingSections()

◆ ShowEdgeLights()

◆ ShowFaceLights()

◆ ShowFaces()

◆ ShowGenericEdges()

◆ ShowHardEdges()

◆ ShowInteriorSilhouetteEdges()

◆ ShowLeaderLines()

◆ ShowLines()

◆ ShowMarkerLights()

◆ ShowMarkers()

◆ ShowMeshQuadEdges()

◆ ShowNonCulledEdges()

◆ ShowPerimeterEdges()

◆ ShowShadowCasting()

◆ ShowShadowEmitting()

◆ ShowShadowReceiving()

◆ ShowText()

◆ ShowVertices()

◆ ShowWindows()

◆ Type()

◆ UnsetAdjacentEdges()

◆ UnsetCutEdges()