EdgeGenerationOptionsKit

class HPS.EdgeGenerationOptionsKit : HPS.Kit

Public Functions

override void Dispose ()

EdgeGenerationOptionsKit ()

The default constructor creates an empty EdgeGenerationOptionsKit object.

EdgeGenerationOptionsKit (HPS.EdgeGenerationOptionsKit in_kit)

The copy constructor creates a new EdgeGenerationOptionsKit object that contains the same settings as the source EdgeGenerationOptionsKit.

Param in_kit:The source EdgeGenerationOptionsKit to copy.

override bool Empty ()

Indicates whether this EdgeGenerationOptionsKit has any values set on it.

Return:true if no values are set on this EdgeGenerationOptionsKit, false otherwise.

bool Equals (HPS.EdgeGenerationOptionsKit in_kit)

Check if the source EdgeGenerationOptionsKit is equivalent to this EdgeGenerationOptionsKit.

Param in_kit:The source EdgeGenerationOptionsKit to compare to this EdgeGenerationOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.EdgeGenerationOptionsKit in_kit)

Copies the source EdgeGenerationOptionsKit into this EdgeGenerationOptionsKit.

Param in_kit:The source EdgeGenerationOptionsKit to copy.

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

Param in_state:Whether adjacent edges are visible. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetDefaultEdges (bool in_state)

Sets the default visibility of all edges, assumed on if not specified

Param in_state:Whether all edges are visible. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetDefaultFaces (bool in_state)

Sets the default visibility of all faces, assumed on if not specified

Param in_state:Whether faces are visible. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetHardEdgeDihedral (float in_dihedral)

Sets the angle used to determine if adjacent edges form a hard edge.

Param in_dihedral:  the hard edge cutoff angle. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetHardEdges (bool in_state)

Sets the visibility of hard edges.

Param in_state:Whether hard edges are visible. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetIgnoreLocalEdges (bool in_state)

Sets whether local face visibility will be considered.

Param in_state:Whether local edge visibility is considered. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetIgnoreLocalFaces (bool in_state)

Sets whether local face visibility will be considered.

Param in_state:Whether local face visibility is considered. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetMeshQuadEdges (bool in_state)

Sets the visibility of edges of mesh quads.

Param in_state:Whether mesh quad edges are visible. Return:A reference to this object.

HPS.EdgeGenerationOptionsKit SetPerimeterEdges (bool in_state)

Sets the visibility of perimeter edges.

Param in_state:Whether perimeter edges are visible. Return:A reference to this object.

void Show (out HPS.EdgeGenerationOptionsKit out_kit)

Copies this EdgeGenerationOptionsKit into the given EdgeGenerationOptionsKit.

Param out_kit:The EdgeGenerationOptionsKit to populate with the contents of this EdgeGenerationOptionsKit.

bool ShowAdjacentEdges (out bool out_state)

Shows the visibility setting for adjacent edges.

Param out_state:  Whether adjacent edges are visible. Return:true if the setting is valid, false otherwise.

bool ShowDefaultEdges (out bool out_state)

Shows the default visibility setting for edges.

Param out_state:  Whether edges are considered visible by default. Return:true if the setting is valid, false otherwise.

bool ShowDefaultFaces (out bool out_state)

Shows the default visibility setting for faces.

Param out_state:  Whether faces are considered visible by default. Return:true if the setting is valid, false otherwise.

bool ShowHardEdgeDihedral (out float out_dihedral)

Shows the angle limit for determination of hard edges.

Param out_dihedral:  dihedral angle limit. Return:true if the setting is valid, false otherwise.

bool ShowHardEdges (out bool out_state)

Shows the visibility setting for hard edges.

Param out_state:  Whether hard edges are visible. Return:true if the setting is valid, false otherwise.

bool ShowIgnoreLocalEdges (out bool out_state)

Shows whether any local edge visibility settings will be considered.

Param out_state:  Whether local edge visibility settings will be considered. Return:true if the setting is valid, false otherwise.

bool ShowIgnoreLocalFaces (out bool out_state)

Shows whether any local face visibility settings will be considered.

Param out_state:  Whether local face visibility settings will be considered. Return:true if the setting is valid, false otherwise.

bool ShowMeshQuadEdges (out bool out_state)

Shows the visibility setting for edges of mesh quads.

Param out_state:  Whether mesh quad edges are visible. Return:true if the setting is valid, false otherwise.

bool ShowPerimeterEdges (out bool out_state)

Shows the visibility setting for perimeter edges.

Param out_state:  Whether perimeter edges are visible. Return:true if the setting is valid, false otherwise.

HPS.EdgeGenerationOptionsKit UnsetAdjacentEdges ()

Removes the visibility setting for adjacent edges.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetDefaultEdges ()

Removes the default visibility settings for all edges.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetDefaultFaces ()

Removes the default visibility setting for faces.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetEverything ()

Removes all visibility settings.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetHardEdgeDihedral ()

Removes the settings for the hard edge dihedral angle.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetHardEdges ()

Removes the visibility setting for hard edges.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetIgnoreLocalEdges ()

Removes the setting for ignoring local edge visibility.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetIgnoreLocalFaces ()

Removes the setting for ignoring local face visibility.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetMeshQuadEdges ()

Removes the visibility setting for edges of mesh quads.

Return:A reference to this object.

HPS.EdgeGenerationOptionsKit UnsetPerimeterEdges ()

Removes the visibility setting for perimeter edges.

Return:A reference to this object.

Public Static Functions

bool operator!= (HPS.EdgeGenerationOptionsKit a, HPS.EdgeGenerationOptionsKit b)

bool operator== (HPS.EdgeGenerationOptionsKit a, HPS.EdgeGenerationOptionsKit b)