oaRef

模块: oapy._oa._design 导入: from oapy._oa import _design

概览

oaRef 在 oapy 中可用，可通过 _design 模块访问。

本页汇总 oaRef 当前在 oapy 中可用的 Python 接口。

详细说明

This file contains the definition for the oaRef class。 This is an abstract base for all types of instances and vias。 It implements the functionality common to the two derived classes: oaInst and oaVia 。

方法总览

状态	Python 调用
✅	`obj.getHeader()`
✅	`obj.getMaster()`
✅	`obj.getOrigin(origin)`
✅	`obj.getOrient()`
✅	`obj.getTransform(xform)`
✅	`obj.isBound()`
✅	`obj.setOrigin(origin)`
✅	`obj.setOrient(orient)`
✅	`obj.setTransform(xform)`

方法说明

`obj.getHeader()`

绑定状态: 已绑定

Python 调用: obj.getHeader()

This function returns the header for this reference。在 oaInst、oaVia、oaStdVia 和 oaCustomVia 中重新实现。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.getHeader()

`obj.getMaster()`

绑定状态: 已绑定

Python 调用: obj.getMaster()

This function returns the master for this reference。 If the reference cannot be bound to a master, a NULL pointer is returned。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.getMaster()

`obj.getOrigin(origin)`

绑定状态: 已绑定

Python 调用: obj.getOrigin(origin)

This function fills out 'origin' with the origin of this reference。

参数

origin: The origin of this ref object。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.getOrigin(origin)

`obj.getOrient()`

绑定状态: 已绑定

Python 调用: obj.getOrient()

This function returns the orientation of this reference。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.getOrient()

`obj.getTransform(xform)`

绑定状态: 已绑定

Python 调用: obj.getTransform(xform)

This function fills out 'xform' with the transform of this reference。

参数

xform: The transform of this ref object。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.getTransform(xform)

`obj.isBound()`

绑定状态: 已绑定

Python 调用: obj.isBound()

This function returns a boolean indicating whether or not this reference is bound。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.isBound()

`obj.setOrigin(origin)`

绑定状态: 已绑定

Python 调用: obj.setOrigin(origin)

This function sets the origin value for this ref object。

参数

origin: The origin to be set to this ref object。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.setOrigin(origin)

`obj.setOrient(orient)`

绑定状态: 已绑定

Python 调用: obj.setOrient(orient)

This function sets the orientation for this ref object。

参数

orient: The orientation to be set to this ref object。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.setOrient(orient)

`obj.setTransform(xform)`

绑定状态: 已绑定

Python 调用: obj.setTransform(xform)

This function sets the transform for this ref object。

参数

xform: The transform value to be set for this ref object。

Python 示例

from oapy._oa import _design

# assume obj is a oaRef
obj.setTransform(xform)