NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::SessionWorkPlane Class Reference

Represents the set of WorkPlane preferences applicable to session
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX3.0.0. More...

List of all members.

Public Types

enum  ObjectDisplay { ObjectDisplayNormal, ObjectDisplayDimAndSelectable, ObjectDisplayDimAndNonSelectable }
 Describes whether the object off work plane is normal display or dim and selectable or dim and non selectable. More...

Public Member Functions

int DimColor ()
 Returns the dim color
This property is deprecated.
NXOpen::Preferences::SessionWorkPlane::ObjectDisplay ObjectOffWorkPlane ()
 Returns the object off work plane.
void SetDimColor (int workPlaneDimColor)
 Sets the dim color
This property is deprecated.
void SetObjectOffWorkPlane (NXOpen::Preferences::SessionWorkPlane::ObjectDisplay objectOffWorkPlane)
 Sets the object off work plane.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents the set of WorkPlane preferences applicable to session
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX3.0.0.



Member Enumeration Documentation

Describes whether the object off work plane is normal display or dim and selectable or dim and non selectable.

Enumerator:
ObjectDisplayNormal 

Normal Display.

ObjectDisplayDimAndSelectable 

Dim and Selectable.

ObjectDisplayDimAndNonSelectable 

Dim and Non Selectable.


Member Function Documentation

Returns the dim color
This property is deprecated.

Use NXOpen::Preferences::PartVisualizationColorSetting::DeEmphasisBlendColor and NXOpen::Preferences::PartVisualizationColorSetting::SetDeEmphasisBlendColor instead.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the object off work plane.

Comes under Display tab. This preference is to de-emphasize or "dim" all objects in the work plane.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::SessionWorkPlane::SetDimColor ( int  workPlaneDimColor)

Sets the dim color
This property is deprecated.

Use NXOpen::Preferences::PartVisualizationColorSetting::DeEmphasisBlendColor and NXOpen::Preferences::PartVisualizationColorSetting::SetDeEmphasisBlendColor instead.

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
workPlaneDimColorwork plane dim color

Sets the object off work plane.

Comes under Display tab. This preference is to de-emphasize or "dim" all objects in the work plane.
Created in NX3.0.0.

License requirements : None

Parameters:
objectOffWorkPlaneobject off work plane

Returns the tag of this object.


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