AnyCAD::API::ParameterValue类 参考

The base class for parameter values. 更多...

#include <APIParameterValue.h>

类 AnyCAD::API::ParameterValue 继承关系图:

Public 成员函数
EnumValueType	GetValueType () const
bool	Assign (const ParameterValue &other)
bool	IsEqual (const ParameterValue &other) const
virtual String	ToString () const
virtual bool	FromString (const String &str)
virtual ParameterValue	Clone () const
int	AsInt () const
ElementId	AsElementId () const
double	AsDouble () const
String	AsString () const
bool	AsBool () const
Vector3	AsVector3 () const
Vector2	AsVector2 () const
ColorValue	AsColorValue () const
Public 成员函数 继承自 AnyCAD::API::Object
String	GetObjectClassId () const
StringList	ListParentClassIds () const

详细描述

The base class for parameter values.

TODO:

成员函数说明

bool AnyCAD::API::ParameterValue::AsBool

(

)

const

Get the boolean value.

返回

0 if it's not ParameterString.

ColorValue AnyCAD::API::ParameterValue::AsColorValue

(

)

const

Get the vector3 value.

返回

0 if it's not ParameterString.

double AnyCAD::API::ParameterValue::AsDouble

(

)

const

Get the double value.

返回

0 if it's not ParameterDouble.

ElementId AnyCAD::API::ParameterValue::AsElementId

(

)

const

Get the ElementId value.

返回

Invalid id if it's not ParameterInteger.

int AnyCAD::API::ParameterValue::AsInt

(

)

const

Get the integer value.

返回

0 if it's not ParameterInteger.

bool AnyCAD::API::ParameterValue::Assign

(

const ParameterValue &

other

)

Assign the value to this ParameterValue.

参数

other

the data from.

返回

true if succeeded.

String AnyCAD::API::ParameterValue::AsString

(

)

const

Get the string value.

返回

0 if it's not ParameterString.

Vector2 AnyCAD::API::ParameterValue::AsVector2

(

)

const

Get the vector3 value.

返回

0 if it's not ParameterString.

Vector3 AnyCAD::API::ParameterValue::AsVector3

(

)

const

Get the vector3 value.

返回

0 if it's not ParameterString.

virtual ParameterValue AnyCAD::API::ParameterValue::Clone ( ) const

virtual

Create new ParameterValue with the same value as this one.

返回

the new ParameterValue.

virtual bool AnyCAD::API::ParameterValue::FromString ( const String &  str )

virtual

Parse value from string.

参数

str	the string.

返回

true if done.

被 AnyCAD::API::ParameterBoolean, AnyCAD::API::ParameterColor, AnyCAD::API::ParameterDouble, AnyCAD::API::ParameterElementId, AnyCAD::API::ParameterInteger, AnyCAD::API::ParameterString , 以及 AnyCAD::API::ParameterVector3 重载.

EnumValueType AnyCAD::API::ParameterValue::GetValueType

(

)

const

Get value type.

bool AnyCAD::API::ParameterValue::IsEqual

(

const ParameterValue &

other

)

const

If the two ParameterValues are equal

参数

other

ParameterValue.

返回

true if they are equal.

virtual String AnyCAD::API::ParameterValue::ToString ( ) const

virtual

Convert to string.

返回

to string.

被 AnyCAD::API::ParameterBoolean, AnyCAD::API::ParameterColor, AnyCAD::API::ParameterDouble, AnyCAD::API::ParameterElementId, AnyCAD::API::ParameterInteger, AnyCAD::API::ParameterString , 以及 AnyCAD::API::ParameterVector3 重载.

---

该类的文档由以下文件生成:

• E:/Depot/sdk.cpp.ent/inc/Core/APIParameterValue.h