NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
Public 类型 | Public 成员函数 | 友元 | 所有成员列表
NXOpen::Light类 参考

光源类 更多...

#include <Light.hxx>

类 NXOpen::Light 继承关系图:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

Public 类型

enum  SceneType {
  SceneTypeNotASceneLight = -1 , SceneTypeAmbient , SceneTypeLeftTop , SceneTypeTop ,
  SceneTypeRightTop , SceneTypeFront , SceneTypeLeftBottom , SceneTypeBottom ,
  SceneTypeRightBottom
}
Public 类型 继承自 NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid , AttributeTypeNull , AttributeTypeBoolean , AttributeTypeInteger ,
  AttributeTypeReal , AttributeTypeString , AttributeTypeTime , AttributeTypeReference ,
  AttributeTypeAny = 100
}
enum  DateAndTimeFormat { DateAndTimeFormatNumeric , DateAndTimeFormatTextual }

Public 成员函数

bool GetEnabledInView (NXOpen::View *view)
void GetLightType (NXOpen::Display::LightType *lightType, NXOpen::Light::SceneType *sceneLightType)
double Intensity ()
void SetEnabledInView (NXOpen::View *view, bool onOrOff)
void SetIntensity (double intensity)
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 _LightBuilder

额外继承的成员函数

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

详细描述

光源类

表示光源。
目前不支持创建光源。

于NX4.0.0创建。

成员枚举类型说明

◆ SceneType

enum NXOpen::Light::SceneType

基础光照中使用的预定义场景光源。这些是 Display::LightTypeScene 的子类型。除环境光外，所有其他光源 均位于模型与观察者同侧。

枚举值
SceneTypeNotASceneLight 

该光源不是场景光源

SceneTypeAmbient 

来自模型四周的光

SceneTypeLeftTop 

来自视图左上方的光

SceneTypeTop 

来自视图正上方的光

SceneTypeRightTop 

来自视图右上方的光

SceneTypeFront 

来自视图前方（观察者位置）的光

SceneTypeLeftBottom 

来自视图左下方的光

SceneTypeBottom 

来自视图正下方的光

SceneTypeRightBottom 

来自视图右下方的光

成员函数说明

◆ GetEnabledInView()

bool NXOpen::Light::GetEnabledInView ( NXOpen::View * view)

检查光源在指定视图中是否启用。true表示开启，false表示关闭。

返回
true：开启，false：关闭
于NX4.0.0创建。

许可要求：无
参数
view待检查的视图

◆ GetLightType()

void NXOpen::Light::GetLightType ( NXOpen::Display::LightType * lightType,
NXOpen::Light::SceneType * sceneLightType )

获取光源的类型。如果是场景光源，还会返回具体的场景光源类型。如果不是场景光源，scene_light_type输出未定义。
于NX4.0.0创建。

许可要求：无

参数
lightType光源类型
sceneLightType若light_type为...scene， 此为具体场景光源类型

◆ Intensity()

double NXOpen::Light::Intensity ( )

返回光源的强度。强度通常在0.0（完全关闭）到1.0（完全开启）范围内，除非场景光源外，强度可能大于1.0。
注意，即使光源在任何视图中未显示，强度仍可能大于0.0，因为下次开启时会使用此强度。

目前，设置 Light::SetIntensity 可能仅用于场景光源。

于NX4.0.0创建。

许可要求：无

◆ SetEnabledInView()

void NXOpen::Light::SetEnabledInView ( NXOpen::View * view,
bool onOrOff )

设置光源在指定视图中是否启用。true表示开启，false表示关闭。目前，光源必须是 Display::LightTypeScene 类型。
于NX4.0.0创建。

许可要求：无

参数
view要开启或关闭光源的视图
onOrOfftrue为开启，false为关闭

◆ SetIntensity()

void NXOpen::Light::SetIntensity ( double intensity)

设置光源的强度。强度通常在0.0（完全关闭）到1.0（完全开启）范围内，除非场景光源外，强度可能大于1.0。
注意，即使光源在任何视图中未显示，强度仍可能大于0.0，因为下次开启时会使用此强度。

目前，设置 Light::SetIntensity 可能仅用于场景光源。

于NX4.0.0创建。

许可要求：无

参数
intensity强度