NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Display.FacetSettingsBuilder Class Reference

Represents a NXOpen.Display.FacetSettingsBuilder More...

Inheritance diagram for NXOpen.Display.FacetSettingsBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  AdvVisToleranceSetting {
  Coarse, Standard, Fine, ExtraFine,
  SuperFine, UltraFine, UserDefined
}
 Specifies which set of tolerances are to be used for rendering facets for display for Advanced Visualization views. More...
 
enum  FacetScale { Fixed, Part, View }
 Denotes what type of scaling factor is applied to the corresponding tolerances used to generate facets. More...
 
enum  FacetToViewRatio { Automatic, UserDefined }
 Specifies whether the ratio of the view scale to the scale used to generate facets is determined automatically by the system (as was always done before NX 8) or whether a ratio defined by the user (by one of the set_*FacetRatio methods) is to be used as the ratio. More...
 
enum  FacetUpdate { VisibleObjects, AllObjects, None }
 Specifies whether an Update Display or Fit operation is to regenerate the facets for only visible objects, for all objects or for no objects. More...
 
enum  ShadedToleranceSetting {
  Coarse, Standard, Fine, ExtraFine,
  UltraFine, UserDefined
}
 Specifies which set of tolerances are to be used for rendering facets for display for Shaded views. More...
 

Public Member Functions

unsafe double GetAdvVisAngleTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance)
 Returns the angle tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe double GetAdvVisEdgeTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance)
 Returns the edge tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe double GetAdvVisFaceTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance)
 Returns the face tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe double GetAdvVisWidthTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance)
 Returns the width tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe double GetShadedAngleTol (NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting shadedTolerance)
 Returns the angle tolerance for a given tolerance set for Shaded Views More...
 
unsafe double GetShadedEdgeTol (NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting shadedTolerance)
 Returns the edge tolerance for a given tolerance set for Shaded Views More...
 
unsafe double GetShadedFaceTol (NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting shadedTolerance)
 Returns the face tolerance for a given tolerance set for Shaded Views More...
 
unsafe void RegenerateDisplayFacets (bool deleteSavedDisplayFacets, bool regenerateChildren, NXOpen.BasePart partScope)
 Regenerates display specific cached facets in the specified part. More...
 
unsafe void SetAdvVisAngleTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance, double advVisAngleTol)
 Sets the angle tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe void SetAdvVisEdgeTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance, double advVisEdgeTol)
 Sets the edge tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe void SetAdvVisFaceTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance, double advVisFaceTol)
 Sets the face tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe void SetAdvVisWidthTol (NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting advVisTolerance, double advVisWidthTol)
 Sets the width tolerance for a given tolerance set for Advanced Visualization Views More...
 
unsafe void SetShadedAngleTol (NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting shadedTolerance, double shadedAngleTol)
 Sets the angle tolerance for a given tolerance set for Shaded Views More...
 
unsafe void SetShadedEdgeTol (NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting shadedTolerance, double shadedEdgeTol)
 Sets the edge toleramce for a given tolerance set for Shaded Views More...
 
unsafe void SetShadedFaceTol (NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting shadedTolerance, double shadedFaceTol)
 Sets the face tolerance for a given tolerance set for Shaded Views More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool AdvVisAlignFacets [get, set]
 Returns or sets the state of whether facets for advanced visualization views should be aligned along common edges. More...
 
unsafe double AdvVisFacetRatio [get, set]
 Returns or sets the facet ratio to use for Advanced Visualization Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.FacetScale 
AdvVisFacetScale [get, set]
 Returns or sets the facet scale to use for Advanced Visualization Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.FacetToViewRatio 
AdvVisFacetToViewRatio [get, set]
 Returns or sets the facet to view ratio to use for Advanced Visualization Views More...
 
unsafe double AdvVisRefinementFactor [get, set]
 Returns or sets the refinement factor to use for Advanced Visualization Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting 
AdvVisTolerance [get, set]
 Returns or sets the tolerance setting to use for Advanced Visualization Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.FacetUpdate 
AdvVisUpdate [get, set]
 Returns or sets the update mode to use for Advanced Visualization Views More...
 
unsafe bool ShadedAlignFacets [get, set]
 Returns or sets the state of whether facets for shaded views should be aligned along common edges. More...
 
unsafe double ShadedFacetRatio [get, set]
 Returns or sets the facet ratio to use for Shaded Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.FacetScale 
ShadedFacetScale [get, set]
 Returns or sets the facet scale to use for Shaded Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.FacetToViewRatio 
ShadedFacetToViewRatio [get, set]
 Returns or sets the facet to view ratio to use for Shaded Views More...
 
unsafe double ShadedRefinementFactor [get, set]
 Returns or sets the refinement factor to use for Shaded Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting 
ShadedTolerance [get, set]
 Returns or sets the tolerance setting to use for Shaded Views More...
 
unsafe
NXOpen.Display.FacetSettingsBuilder.FacetUpdate 
ShadedUpdate [get, set]
 Returns or sets the update mode to use for Shaded Views More...
 
unsafe bool ShowFacetEdges [get, set]
 Returns or sets the state of whether facet edges should be shown for shaded solid and sheet bodies More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Display.FacetSettingsBuilder

Facet Settings are not supported in KF.

Created in NX8.0.0

Member Enumeration Documentation

Specifies which set of tolerances are to be used for rendering facets for display for Advanced Visualization views.

Enumerator
Coarse 
Standard 
Fine 
ExtraFine 
SuperFine 
UltraFine 
UserDefined 

Denotes what type of scaling factor is applied to the corresponding tolerances used to generate facets.

Enumerator
Fixed 

Adjusts tolerances by a constant value

Part 

Adjusts tolerances by scale derived from bounding box of objects to facet in part

View 

Adjusts tolerances by view scale

Specifies whether the ratio of the view scale to the scale used to generate facets is determined automatically by the system (as was always done before NX 8) or whether a ratio defined by the user (by one of the set_*FacetRatio methods) is to be used as the ratio.

Enumerator
Automatic 
UserDefined 

Specifies whether an Update Display or Fit operation is to regenerate the facets for only visible objects, for all objects or for no objects.

Enumerator
VisibleObjects 
AllObjects 
None 

Specifies which set of tolerances are to be used for rendering facets for display for Shaded views.

Enumerator
Coarse 
Standard 
Fine 
ExtraFine 
UltraFine 
UserDefined 

Member Function Documentation

unsafe double NXOpen.Display.FacetSettingsBuilder.GetAdvVisAngleTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance)
inline

Returns the angle tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
Returns
unsafe double NXOpen.Display.FacetSettingsBuilder.GetAdvVisEdgeTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance)
inline

Returns the edge tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
Returns
unsafe double NXOpen.Display.FacetSettingsBuilder.GetAdvVisFaceTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance)
inline

Returns the face tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
Returns
unsafe double NXOpen.Display.FacetSettingsBuilder.GetAdvVisWidthTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance)
inline

Returns the width tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
Returns
unsafe double NXOpen.Display.FacetSettingsBuilder.GetShadedAngleTol ( NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting  shadedTolerance)
inline

Returns the angle tolerance for a given tolerance set for Shaded Views

Created in NX8.0.0

License requirements: None.

Parameters
shadedTolerance
Returns
unsafe double NXOpen.Display.FacetSettingsBuilder.GetShadedEdgeTol ( NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting  shadedTolerance)
inline

Returns the edge tolerance for a given tolerance set for Shaded Views

Created in NX8.0.0

License requirements: None.

Parameters
shadedTolerance
Returns
unsafe double NXOpen.Display.FacetSettingsBuilder.GetShadedFaceTol ( NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting  shadedTolerance)
inline

Returns the face tolerance for a given tolerance set for Shaded Views

Created in NX8.0.0

License requirements: None.

Parameters
shadedTolerance
Returns
unsafe void NXOpen.Display.FacetSettingsBuilder.RegenerateDisplayFacets ( bool  deleteSavedDisplayFacets,
bool  regenerateChildren,
NXOpen.BasePart  partScope 
)
inline

Regenerates display specific cached facets in the specified part.

Display facets that are currently saved in the part can be deleted along with the transient display facets. Deleting saved display facets will mark the part as modified. Builder changes will be committed before regenerating display facets.

Created in NX12.0.2

License requirements: None.

Parameters
deleteSavedDisplayFacetsIndicates if saved display facets should be deleted
regenerateChildrenIndicates if the children of this part have their cached display facets regenerated
partScopePart scope for regeneration. This is optional. If a null reference (Nothing in Visual Basic) is specified then the builder part is used.
unsafe void NXOpen.Display.FacetSettingsBuilder.SetAdvVisAngleTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance,
double  advVisAngleTol 
)
inline

Sets the angle tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
advVisAngleTol
unsafe void NXOpen.Display.FacetSettingsBuilder.SetAdvVisEdgeTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance,
double  advVisEdgeTol 
)
inline

Sets the edge tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
advVisEdgeTol
unsafe void NXOpen.Display.FacetSettingsBuilder.SetAdvVisFaceTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance,
double  advVisFaceTol 
)
inline

Sets the face tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
advVisFaceTol
unsafe void NXOpen.Display.FacetSettingsBuilder.SetAdvVisWidthTol ( NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting  advVisTolerance,
double  advVisWidthTol 
)
inline

Sets the width tolerance for a given tolerance set for Advanced Visualization Views

Created in NX8.0.0

License requirements: None.

Parameters
advVisTolerance
advVisWidthTol
unsafe void NXOpen.Display.FacetSettingsBuilder.SetShadedAngleTol ( NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting  shadedTolerance,
double  shadedAngleTol 
)
inline

Sets the angle tolerance for a given tolerance set for Shaded Views

Created in NX8.0.0

License requirements: None.

Parameters
shadedTolerance
shadedAngleTol
unsafe void NXOpen.Display.FacetSettingsBuilder.SetShadedEdgeTol ( NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting  shadedTolerance,
double  shadedEdgeTol 
)
inline

Sets the edge toleramce for a given tolerance set for Shaded Views

Created in NX8.0.0

License requirements: None.

Parameters
shadedTolerance
shadedEdgeTol
unsafe void NXOpen.Display.FacetSettingsBuilder.SetShadedFaceTol ( NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting  shadedTolerance,
double  shadedFaceTol 
)
inline

Sets the face tolerance for a given tolerance set for Shaded Views

Created in NX8.0.0

License requirements: None.

Parameters
shadedTolerance
shadedFaceTol

Property Documentation

unsafe bool NXOpen.Display.FacetSettingsBuilder.AdvVisAlignFacets
getset

Returns or sets the state of whether facets for advanced visualization views should be aligned along common edges.

Using this option will generally increase the quality of the facets but the facet generation will generally take longer.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.FacetSettingsBuilder.AdvVisFacetRatio
getset

Returns or sets the facet ratio to use for Advanced Visualization Views

Created in NX8.0.0

Deprecated in NX9.0.0. Refer to NXOpen.Display.FacetSettingsBuilder.AdvVisRefinementFactor instead

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.FacetScale NXOpen.Display.FacetSettingsBuilder.AdvVisFacetScale
getset

Returns or sets the facet scale to use for Advanced Visualization Views

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.FacetToViewRatio NXOpen.Display.FacetSettingsBuilder.AdvVisFacetToViewRatio
getset

Returns or sets the facet to view ratio to use for Advanced Visualization Views

Created in NX8.0.0

Deprecated in NX9.0.0. Refer to NXOpen.Display.FacetSettingsBuilder.AdvVisFacetScale instead

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.FacetSettingsBuilder.AdvVisRefinementFactor
getset

Returns or sets the refinement factor to use for Advanced Visualization Views

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.AdvVisToleranceSetting NXOpen.Display.FacetSettingsBuilder.AdvVisTolerance
getset

Returns or sets the tolerance setting to use for Advanced Visualization Views

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.FacetUpdate NXOpen.Display.FacetSettingsBuilder.AdvVisUpdate
getset

Returns or sets the update mode to use for Advanced Visualization Views

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.FacetSettingsBuilder.ShadedAlignFacets
getset

Returns or sets the state of whether facets for shaded views should be aligned along common edges.

Using this option will generally increase the quality of the facets but the facet generation will generally take longer.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.FacetSettingsBuilder.ShadedFacetRatio
getset

Returns or sets the facet ratio to use for Shaded Views

Created in NX8.0.0

Deprecated in NX9.0.0. Refer to NXOpen.Display.FacetSettingsBuilder.ShadedRefinementFactor instead

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.FacetScale NXOpen.Display.FacetSettingsBuilder.ShadedFacetScale
getset

Returns or sets the facet scale to use for Shaded Views

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.FacetToViewRatio NXOpen.Display.FacetSettingsBuilder.ShadedFacetToViewRatio
getset

Returns or sets the facet to view ratio to use for Shaded Views

Created in NX8.0.0

Deprecated in NX9.0.0. Refer to NXOpen.Display.FacetSettingsBuilder.ShadedFacetScale instead

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.FacetSettingsBuilder.ShadedRefinementFactor
getset

Returns or sets the refinement factor to use for Shaded Views

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.ShadedToleranceSetting NXOpen.Display.FacetSettingsBuilder.ShadedTolerance
getset

Returns or sets the tolerance setting to use for Shaded Views

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.FacetSettingsBuilder.FacetUpdate NXOpen.Display.FacetSettingsBuilder.ShadedUpdate
getset

Returns or sets the update mode to use for Shaded Views

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.FacetSettingsBuilder.ShowFacetEdges
getset

Returns or sets the state of whether facet edges should be shown for shaded solid and sheet bodies

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.