NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::ModelingView Class Reference

Represents a Modeling View
Modeling Views may only be created by Save As. More...

Inheritance diagram for NXOpen::ModelingView:
NXOpen::View NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Annotations::LightweightSectionView NXOpen::Annotations::SearchModelView NXOpen::CutView

List of all members.

Classes

struct  OtherSectionAttrT
 This defines the attributes data for dynamic sectioning
More...

Public Types

enum  SectionCap { SectionCapOff, SectionCapOn, SectionCapBodyColor, SectionCapBodyColorAndInterference }
 Defines whether to disable and enable capping. More...
enum  SectionPlane { SectionPlanePrimary, SectionPlaneSecondary }
 This arbitrarily defines an initaial reference point. More...

Public Member Functions

NXOpen::Display::DynamicSectionActiveDynamicSection ()
 Returns the active dynamic section object in the modeling view.
bool DisplaySectioningToggle ()
 Returns the toggle between enabling or disabling the Dynamic Sectioning viewing
Created in NX4.0.0.
void GetDisplaySectioning (NXOpen::Matrix3x3 *sectionMatrix, NXOpen::Point3d *sectionOrigin, std::vector< double > &planeDist, NXOpen::ModelingView::OtherSectionAttrT *otherAttrs)
 To adjust and orient the Sectioning planes as a quick display trick.
NXOpen::ModelingViewHighQualityImageHiqhQualityImage ()
 Returns the High Quality Image instance belonging to a view
Created in NX3.0.0.
bool IsDynamicSectionVisible (NXOpen::Display::DynamicSection *dynamicSection)
 Returns if the specified dynamic section object is visible in this view.
void SetActiveDynamicSection (NXOpen::Display::DynamicSection *dynamicSection)
 Sets the active dynamic section object in the modeling view.
void SetDisplaySectioning (const NXOpen::Matrix3x3 &sectionMatrix, const NXOpen::Point3d &sectionOrigin, const std::vector< double > &planeDist, const NXOpen::ModelingView::OtherSectionAttrT &otherAttrs)
 To adjust and orient the Sectioning planes as a quick display trick.
void SetDisplaySectioningToggle (bool newState)
 Sets the toggle between enabling or disabling the Dynamic Sectioning viewing
Created in NX4.0.0.
void SetDynamicSectionVisible (NXOpen::Display::DynamicSection *dynamicSection, bool visible)
 Sets the specified dynamic section object is visible/invisible in this view.
void UseDefaultLights ()
 Changes the set of lights used in the given view to the "Default" set, which for now is the Scene Ambient, Scene Left Top and Scene Right Top lights.
void UseSceneLights ()
 Changes the set of lights used in the given view to the "Scene" set, which for now includes the eight predefined scene lights (including the Scene Ambient light).

Detailed Description

Represents a Modeling View
Modeling Views may only be created by Save As.



Created in NX4.0.0.


Member Enumeration Documentation

Defines whether to disable and enable capping.

If enabled, the capping color can be further defined by 'cap_color', or using the color of the solid that is being sectioned. If desired, solid interference check can also be enabled for visual inspection

Deprecated:
Deprecated in NX5.0.0.
Enumerator:
SectionCapOff 

disable

SectionCapOn 

enable using cap_color

SectionCapBodyColor 

enable using color of solid body

SectionCapBodyColorAndInterference 

with interference check

This arbitrarily defines an initaial reference point.

If the 'primary' plane, which is farther from WCS, or the 'secondary' plane, which is closer to WCS, should be the active sectioning (cutting) plane

Deprecated:
Deprecated in NX5.0.0.
Enumerator:
SectionPlanePrimary 

Primary.

SectionPlaneSecondary 

Secondary.


Member Function Documentation

Returns the active dynamic section object in the modeling view.


Each modeling view can contain one and only one active dynamic section. Trying to reset the active dynamic section in the view by specifying NULL dynamic section will raise an error.


Created in NX6.0.0.

License requirements : None

Returns the toggle between enabling or disabling the Dynamic Sectioning viewing
Created in NX4.0.0.



License requirements : None

void NXOpen::ModelingView::GetDisplaySectioning ( NXOpen::Matrix3x3 sectionMatrix,
NXOpen::Point3d sectionOrigin,
std::vector< double > &  planeDist,
NXOpen::ModelingView::OtherSectionAttrT otherAttrs 
)

To adjust and orient the Sectioning planes as a quick display trick.

It is not to confuse this operation with the TURE modeling boolean operation. All the attributes used are for the benefit of the UI dialog. The View Sectioning operation is really meanlingless when it is not in interactive mode without visual feedback (UI). But for journaling playback to work properly, we must remember the states of all the setting in the dialog.

There can be a max of six section planes at one time 'sectioning' out a geometry. When all are enabled, they are 3 set of 2-parallel planes. These 3 sets are ALWAYS perpendicular to each other much like the XYZ coordinate. Therefore, one 1 rotation matrix is required to orient all these 6 planes. Either 1, 2 or 6 planes can be enabled at anytime. Initially, these 3 sets are parallel to the x-y plane, x-z plane, and the y-z plane of the WCS respectively.

With this API, user can update the distance of all 6 planes even the number of active planes are 1 or 2. Therefore, the sizeof 'plane_dist' array does not have to be the same as field total_planes_active in ModelingView::OtherSectionAttrT .

For further details on how dynamic sectioning works, please refer to the UG doc.


This method is deprecated. Use BasePart::CreateDynamicSectionBuilder to create section builder and query sectioning attributes stored in a view.


Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : None

Parameters:
sectionMatrixSection planes matrix relative to ABS coord
sectionOriginCenter of rectangle representing the active plane
planeDistdistance from section_object_origin of the 6 planes
otherAttrsadditional sectioning attrs

Returns the High Quality Image instance belonging to a view
Created in NX3.0.0.


Returns if the specified dynamic section object is visible in this view.


When dynamic section object is visible, the section curves are shown in the view.

Returns:
Visibility flag
Created in NX6.0.0.

License requirements : None
Parameters:
dynamicSectionDynamic section object

Sets the active dynamic section object in the modeling view.


Each modeling view can contain one and only one active dynamic section. Trying to reset the active dynamic section in the view by specifying NULL dynamic section will raise an error.


Created in NX6.0.0.

License requirements : None

Parameters:
dynamicSectionDynamic section object. Specify NULL to reset active dynamic section.
void NXOpen::ModelingView::SetDisplaySectioning ( const NXOpen::Matrix3x3 sectionMatrix,
const NXOpen::Point3d sectionOrigin,
const std::vector< double > &  planeDist,
const NXOpen::ModelingView::OtherSectionAttrT otherAttrs 
)

To adjust and orient the Sectioning planes as a quick display trick.

It is not to confuse this operation with the TRUE modeling boolean operation. All the attributes used are for the benefit of the UI dialog. The View Sectioning operation is really meanlingless when it is not in interactive mode without visual feedback (UI). But for journaling playback to work properly, we must remember the states of all the setting in the dialog.

There can be a max of six section planes at one time 'sectioning' out a geometry. When all are enabled, they are 3 set of 2-parallel planes. These 3 sets are ALWAYS perpendicular to each other much like the XYZ coordinate. Therefore, one 1 rotation matrix is required to orient all these 6 planes. Either 1, 2 or 6 planes can be enabled at anytime. Initially, these 3 sets are parallel to the x-y plane, x-z plane, and the y-z plane of the WCS respectively.

With this API, user can update the distance of all 6 planes even the number of active planes are 1 or 2. Therefore, the sizeof 'plane_dist' array does not have to be the same as field total_planes_active in ModelingView::OtherSectionAttrT .

For further details on how dynamic sectioning works, please refer to the UG doc.


This method is deprecated. Use BasePart::CreateDynamicSectionBuilder to create section builder and modify view sectioning definition.


Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : None

Parameters:
sectionMatrixSection planes matrix relative to ABS coord
sectionOriginCenter of rectangle representing the active plane
planeDistdistance from section_object_origin of the 6 planes
otherAttrsadditional sectioning attrs

Sets the toggle between enabling or disabling the Dynamic Sectioning viewing
Created in NX4.0.0.



License requirements : None

Parameters:
newStateTo enable or disable dyanamic Sectioning on display

Sets the specified dynamic section object is visible/invisible in this view.


When dynamic section object is visible, the section curves are shown in the view. Showing section objects in a view is a performance intensive operation. In involves cutting all visible bodies in the view with the section object definition.


Created in NX6.0.0.

License requirements : None

Parameters:
dynamicSectionDynamic section object
visibleVisibility flag

Changes the set of lights used in the given view to the "Default" set, which for now is the Scene Ambient, Scene Left Top and Scene Right Top lights.

If the definition of the "Default" set should ever change, the implementation of this method would change accordingly.


Created in NX4.0.0.

License requirements : None

Changes the set of lights used in the given view to the "Scene" set, which for now includes the eight predefined scene lights (including the Scene Ambient light).

If the definition of the "Scene" set should ever change, the implementation of this method would change accordingly.


Created in NX4.0.0.

License requirements : None


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