工作平面首选项类更多...

#include <Preferences_WorkPlane.hxx>

类 NXOpen::Preferences::WorkPlane 继承关系图:

类
struct	GridSize
struct	NonuniformGridSize
struct	PolarGridSize

Public 类型
enum	Grid { GridPolar , GridRectangular }
Public 类型继承自 NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid , AttributeTypeNull , AttributeTypeBoolean , AttributeTypeInteger , AttributeTypeReal , AttributeTypeString , AttributeTypeTime , AttributeTypeReference , AttributeTypeAny = 100 }
enum	DateAndTimeFormat { DateAndTimeFormatNumeric , DateAndTimeFormatTextual }

Public 成员函数
NXOpen::Preferences::WorkPlane::PolarGridSize	GetPolarGridSize ()
NXOpen::Preferences::WorkPlane::NonuniformGridSize	GetRectangularNonuniformGridSize ()
NXOpen::Preferences::WorkPlane::GridSize	GetRectangularUniformGridSize ()
int	GridColor ()
bool	GridIsNonUniform ()
bool	GridOnTop ()
NXOpen::Preferences::WorkPlane::Grid	GridType ()
bool	PolarShowMajorLines ()
bool	RectangularShowMajorLines ()
void	SetGridColor (int gridColor)
void	SetGridIsNonUniform (bool gridIsNonUniform)
void	SetGridOnTop (bool gridOnTop)
void	SetGridType (NXOpen::Preferences::WorkPlane::Grid gridType)
void	SetPolarGridSize (const NXOpen::Preferences::WorkPlane::PolarGridSize &polarGridSize)
void	SetPolarShowMajorLines (bool polarShowMajorLines)
void	SetRectangularNonuniformGridSize (const NXOpen::Preferences::WorkPlane::NonuniformGridSize &nonuniformGridSize)
void	SetRectangularShowMajorLines (bool rectangularShowMajorLines)
void	SetRectangularUniformGridSize (const NXOpen::Preferences::WorkPlane::GridSize &gridSize)
void	SetShowGrid (bool showGrid)
void	SetShowLabels (bool showLabels)
void	SetSnapToGrid (bool snapToGrid)
bool	ShowGrid ()
bool	ShowLabels ()
bool	SnapToGrid ()
Public 成员函数继承自 NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
NX_DEPRECATED("Deprecated in NX8.0.0. Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle(NXOpen void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
NX_DEPRECATED("Deprecated in NX8.0.0. Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle(NXOpen void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
bool	GetBooleanUserAttribute (const char *title, int index)
bool	GetBooleanUserAttribute (const NXString &title, int index)
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
int	GetIntegerAttribute (const char *title)
int	GetIntegerUserAttribute (const char *title, int index)
int	GetIntegerUserAttribute (const NXString &title, int index)
bool	GetNextUserAttribute (NXOpen::AttributeIterator iterator, NXOpen::NXObject::AttributeInformation info)
NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	获取指定对象的PDM参考属性值。用户需提供属性标题，将返回UI显示的属性值。
NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	获取指定对象的PDM参考属性值。用户需提供属性标题，将返回UI显示的属性值。
double	GetRealAttribute (const char *title)
double	GetRealUserAttribute (const char *title, int index)
double	GetRealUserAttribute (const NXString &title, int index)
NXString	GetReferenceAttribute (const char *title)
NXString	GetStringAttribute (const char *title)
NXString	GetStringUserAttribute (const char *title, int index)
NXString	GetStringUserAttribute (const NXString &title, int index)
NX_DEPRECATED("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetTimeAttribute(NXOpen NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
NXString	GetTimeUserAttribute (const char *title, int index)
NXString	GetTimeUserAttribute (const NXString &title, int index)
NX_DEPRECATED("Deprecated in NX11.0.0. Use GetUserAttribute instead.") std std::vector< NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
std::vector< NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
std::vector< NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
std::vector< NXOpen::NXObject::AttributeInformation >	GetUserAttributes (NXOpen::AttributeIterator *iterator)
int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
virtual bool	IsOccurrence ()
virtual NXString	JournalIdentifier ()
virtual NXString	Name ()
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") double GetRealAttribute(const NXString &title)
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") int GetIntegerAttribute(const NXString &title)
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetReferenceAttribute(const NXString &title)
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetStringAttribute(const NXString &title)
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title)
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetReferenceAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetReferenceAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetTimeAttribute(const NXString &title
	NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetTimeAttribute(const NXString &title
virtual NXOpen::Assemblies::Component *	OwningComponent ()
virtual NXOpen::BasePart *	OwningPart ()
virtual void	Print ()
virtual NXOpen::INXObject *	Prototype ()
void	SetAttribute (const char *title)
void	SetAttribute (const char title, const char value)
void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
void	SetAttribute (const char *title, double value)
void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
void	SetAttribute (const char *title, int value)
void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
void	SetAttribute (const char *title, NXOpen::Update::Option option)
void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
virtual void	SetName (const char *name)
virtual void	SetName (const NXString &name)
void	SetPdmReferenceAttribute (const char attributeTitle, const char attributeValue)
	设置对象的PDM参考属性值。用户需提供属性标题和UI显示的别名值。若参考属性为数组类型，此操作将被忽略。别名字符串会转换为内部值（如会话标识符），并将该内部值设置到指定对象上。创建于NX12.0.0。许可要求：无
void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	设置对象的PDM参考属性值。用户需提供属性标题和UI显示的别名值。若参考属性为数组类型，此操作将被忽略。别名字符串会转换为内部值（如会话标识符），并将该内部值设置到指定对象上。创建于NX12.0.0。许可要求：无
void	SetReferenceAttribute (const char title, const char value)
void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
void	SetTimeAttribute (const char title, const char value)
void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
Public 成员函数继承自 NXOpen::TaggedObject
tag_t	Tag () const

友元
class	_WorkPlaneBuilder

额外继承的成员函数
Public 属性继承自 NXOpen::NXObject
NXOpen::Update::Option	option
const NXString NXOpen::Update::Option	option
double NXOpen::Update::Option	option
int NXOpen::Update::Option	option
const NXString &	value
double	value
int	value

详细描述

工作平面首选项类

表示适用于部件的工作平面首选项集合。用于设置图形窗口栅格和工作平面高亮模式。
此类实例可通过Preferences::SessionPreferences::WorkPlane 或Preferences::PartPreferences::Workplane 获取

于NX3.0.0版本创建。

成员枚举类型说明

◆ Grid

enum NXOpen::Preferences::WorkPlane::Grid

描述所选栅格类型是极坐标还是直角坐标

枚举值
GridPolar	极坐标栅格
GridRectangular	直角坐标栅格

成员函数说明

◆ GetPolarGridSize()

NXOpen::Preferences::WorkPlane::PolarGridSize NXOpen::Preferences::WorkPlane::GetPolarGridSize ( )

查询极坐标网格尺寸参数。

返回: 创建于NX6.0.0.

许可要求: 无

◆ GetRectangularNonuniformGridSize()

NXOpen::Preferences::WorkPlane::NonuniformGridSize NXOpen::Preferences::WorkPlane::GetRectangularNonuniformGridSize ( )

查询直角坐标非均匀网格尺寸参数。

返回: 创建于NX6.0.0.

许可要求: 无

◆ GetRectangularUniformGridSize()

NXOpen::Preferences::WorkPlane::GridSize NXOpen::Preferences::WorkPlane::GetRectangularUniformGridSize ( )

查询直角坐标均匀网格尺寸参数。

返回: 创建于NX6.0.0.

许可要求: 无

◆ GridColor()

int NXOpen::Preferences::WorkPlane::GridColor ( )

获取网格颜色。指定网格的颜色。
创建于NX3.0.0.

许可要求: 无

◆ GridIsNonUniform()

bool NXOpen::Preferences::WorkPlane::GridIsNonUniform ( )

获取网格非均匀标志。为true时网格为非均匀。均匀网格的X和Y方向间距相同，非均匀网格允许X和Y方向间距不同
创建于NX3.0.0。

许可证要求：无

◆ GridOnTop()

bool NXOpen::Preferences::WorkPlane::GridOnTop ( )

获取网格置于顶层标志。为true时网格显示在场景中其他图形的上方
创建于NX6.0.0。

许可证要求：无

◆ GridType()

NXOpen::Preferences::WorkPlane::Grid NXOpen::Preferences::WorkPlane::GridType ( )

获取网格类型。可以是极坐标或直角坐标
创建于NX3.0.0.

许可要求: 无

◆ PolarShowMajorLines()

bool NXOpen::Preferences::WorkPlane::PolarShowMajorLines ( )

获取极坐标网格的主网格线显示标志
创建于NX6.0.0。

许可证要求：无

◆ RectangularShowMajorLines()

bool NXOpen::Preferences::WorkPlane::RectangularShowMajorLines ( )

获取矩形网格的主网格线显示标志
创建于NX6.0.0。

许可证要求：无

◆ SetGridColor()

void NXOpen::Preferences::WorkPlane::SetGridColor ( int gridColor )

设置网格颜色。指定网格的颜色。
创建于NX3.0.0.

许可要求: 无

参数

gridColor 网格颜色

◆ SetGridIsNonUniform()

void NXOpen::Preferences::WorkPlane::SetGridIsNonUniform ( bool gridIsNonUniform )

设置网格非均匀标志。为true时网格为非均匀。均匀网格的X和Y方向间距相同，非均匀网格允许X和Y方向间距不同
创建于NX3.0.0。

许可证要求：无

参数

gridIsNonUniform 网格非均匀

◆ SetGridOnTop()

void NXOpen::Preferences::WorkPlane::SetGridOnTop ( bool gridOnTop )

设置网格置于顶层标志。为true时网格显示在场景中其他图形的上方
创建于NX6.0.0。

许可证要求：无

参数

gridOnTop 网格置于顶层

◆ SetGridType()

void NXOpen::Preferences::WorkPlane::SetGridType ( NXOpen::Preferences::WorkPlane::Grid gridType )

设置网格类型。可以是极坐标或直角坐标
创建于NX3.0.0.

许可要求: 无

参数

gridType 网格类型

◆ SetPolarGridSize()

void NXOpen::Preferences::WorkPlane::SetPolarGridSize ( const NXOpen::Preferences::WorkPlane::PolarGridSize & polarGridSize )

设置极坐标网格尺寸参数。
创建于NX6.0.0.

许可要求: 无

参数

polarGridSize 极坐标网格尺寸

◆ SetPolarShowMajorLines()

void NXOpen::Preferences::WorkPlane::SetPolarShowMajorLines ( bool polarShowMajorLines )

设置极坐标网格的显示主网格线标志
创建于NX6.0.0.

许可要求: 无

参数

polarShowMajorLines 极坐标显示主网格线

◆ SetRectangularNonuniformGridSize()

void NXOpen::Preferences::WorkPlane::SetRectangularNonuniformGridSize ( const NXOpen::Preferences::WorkPlane::NonuniformGridSize & nonuniformGridSize )

设置直角坐标非均匀网格尺寸参数。
创建于NX6.0.0.

许可要求: 无

参数

nonuniformGridSize 非均匀网格尺寸

◆ SetRectangularShowMajorLines()

void NXOpen::Preferences::WorkPlane::SetRectangularShowMajorLines ( bool rectangularShowMajorLines )

设置矩形网格的主网格线显示标志
创建于NX6.0.0。

许可证要求：无

参数

rectangularShowMajorLines 矩形网格显示主网格线

◆ SetRectangularUniformGridSize()

void NXOpen::Preferences::WorkPlane::SetRectangularUniformGridSize ( const NXOpen::Preferences::WorkPlane::GridSize & gridSize )

设置直角坐标均匀网格尺寸参数。
创建于NX6.0.0.

许可要求: 无

参数

gridSize 网格尺寸

◆ SetShowGrid()

void NXOpen::Preferences::WorkPlane::SetShowGrid ( bool showGrid )

设置网格显示/隐藏标志。为true时在图形窗口显示网格，否则隐藏
创建于NX3.0.0。

许可证要求：无

参数

showGrid 显示网格

◆ SetShowLabels()

void NXOpen::Preferences::WorkPlane::SetShowLabels ( bool showLabels )

设置网格标签显示/隐藏标志。为true时在图形窗口显示网格标签，否则隐藏
创建于NX5.0.0。

许可证要求：无

参数

showLabels 显示标签

◆ SetSnapToGrid()

void NXOpen::Preferences::WorkPlane::SetSnapToGrid ( bool snapToGrid )

设置捕捉到网格标志。为true时启用捕捉（将屏幕指定点移动到最近的网格点）。即使网格隐藏，点仍会捕捉到网格
创建于NX3.0.0。

许可证要求：无

参数

snapToGrid 捕捉到网格

◆ ShowGrid()

bool NXOpen::Preferences::WorkPlane::ShowGrid ( )

获取网格显示/隐藏标志。为true时在图形窗口显示网格，否则隐藏
创建于NX3.0.0。

许可证要求：无

◆ ShowLabels()

bool NXOpen::Preferences::WorkPlane::ShowLabels ( )

获取网格标签显示/隐藏标志。为true时在图形窗口显示网格标签，否则隐藏
创建于NX5.0.0。

许可证要求：无

◆ SnapToGrid()

bool NXOpen::Preferences::WorkPlane::SnapToGrid ( )

获取捕捉到网格标志。为true时启用捕捉（将屏幕指定点移动到最近的网格点）。即使网格隐藏，点仍会捕捉到网格
创建于NX3.0.0。

许可证要求：无

类

Public 类型

Public 成员函数

友元

额外继承的成员函数

详细描述

成员枚举类型说明

◆ Grid

成员函数说明

◆ GetPolarGridSize()

◆ GetRectangularNonuniformGridSize()

◆ GetRectangularUniformGridSize()

◆ GridColor()

◆ GridIsNonUniform()

◆ GridOnTop()

◆ GridType()

◆ PolarShowMajorLines()

◆ RectangularShowMajorLines()

◆ SetGridColor()

◆ SetGridIsNonUniform()

◆ SetGridOnTop()

◆ SetGridType()

◆ SetPolarGridSize()

◆ SetPolarShowMajorLines()

◆ SetRectangularNonuniformGridSize()

◆ SetRectangularShowMajorLines()

◆ SetRectangularUniformGridSize()

◆ SetShowGrid()

◆ SetShowLabels()

◆ SetSnapToGrid()

◆ ShowGrid()

◆ ShowLabels()

◆ SnapToGrid()