oaMarker

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

概览

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

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

详细说明

The oaMarker class implements a marker object。 The intent of marker objects is to support the ability to indicate design violations and the objects that are causing the violation。 A marker allows you to Define an array of points to indicate the area or location of the violation Assign a message string that describes the violation Assign a second string that can be used as a tag for the violation Assign the name of the tool reporting the violation Assign a severity value for the violation Define whether the marker is visible or not for rendering purposes Associate zero or more objects that caused the violation with the marker Define the circumstances under which the marker is automatically deleted; this is designated by the oaMarkerDeleteWhen enumerated type The oaMarker class can be observed by deriving from oaObserver 。

方法总览

状态	Python 调用
✅	obj.transform(scale, angle)
✅	obj.addObject(obj)
✅	obj.removeObject(obj)
✅	obj.isVisible()
✅	obj.isClosed()
✅	obj.getSeverity()
✅	obj.getPoints(points)
✅	obj.getMsg(msg)
✅	obj.getShortMsg(shortMsg)
✅	obj.getTool(tool)
✅	obj.getDeleteWhen()
✅	obj.setIsVisible(val)
✅	obj.setIsClosed(val)
✅	obj.setSeverity(severity)
✅	obj.setPoints(points)
✅	obj.setMsg(msg)
✅	obj.setShortMsg(shortMsg)
✅	obj.setTool(tool)
✅	obj.setDeleteWhen(deleteWhen)
✅	obj.getObjects()
✅	_design.oaMarker.create(block, points, msg, shortMsg, tool, isVisible, isClosed, severity, deleteWhen=oacDeleteOnFirst)

方法说明

obj.transform(scale, angle)

绑定状态: 已绑定

Python 调用: obj.transform(scale, angle)

This function transforms this marker by the specified scale factor and rotation angle。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.transform(scale, angle)

obj.addObject(obj)

绑定状态: 已绑定

Python 调用: obj.addObject(obj)

This function adds the specified object to the list of objects associated with the marker。 An oacObjectAlreadyOnMarker exception is thrown if the object already exists on the marker。

异常

• oacInvalidMarkerMemType。
• oacObjMarkerNotInSameBlock。
• oacObjectAlreadyOnMarker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.addObject(obj)

obj.removeObject(obj)

绑定状态: 已绑定

Python 调用: obj.removeObject(obj)

This function removes the specified object from the list of objects associated with this marker。 This function does nothing if the object is not associated with this marker。

异常

• oacMarkerNotOnThisObject。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.removeObject(obj)

obj.isVisible()

绑定状态: 已绑定

Python 调用: obj.isVisible()

This function returns a boolean that indicates if this marker is visible。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.isVisible()

obj.isClosed()

绑定状态: 已绑定

Python 调用: obj.isClosed()

This function returns a boolean that indicates whether the pointArray associated with this marker is closed。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.isClosed()

obj.getSeverity()

绑定状态: 已绑定

Python 调用: obj.getSeverity()

This function returns the severity attribute associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getSeverity()

obj.getPoints(points)

绑定状态: 已绑定

Python 调用: obj.getPoints(points)

This function fills out points with the pointArray of this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getPoints(points)

obj.getMsg(msg)

绑定状态: 已绑定

Python 调用: obj.getMsg(msg)

This function gets the message string associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getMsg(msg)

obj.getShortMsg(shortMsg)

绑定状态: 已绑定

Python 调用: obj.getShortMsg(shortMsg)

This function gets the short message string associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getShortMsg(shortMsg)

obj.getTool(tool)

绑定状态: 已绑定

Python 调用: obj.getTool(tool)

This function gets the tool string associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getTool(tool)

obj.getDeleteWhen()

绑定状态: 已绑定

Python 调用: obj.getDeleteWhen()

This function returns the deleteWhen attribute of this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getDeleteWhen()

obj.setIsVisible(val)

绑定状态: 已绑定

Python 调用: obj.setIsVisible(val)

This function is used to indicate whether or not this marker is visible。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setIsVisible(val)

obj.setIsClosed(val)

绑定状态: 已绑定

Python 调用: obj.setIsClosed(val)

This function is used to indicate whether the pointArray associated with this marker is closed or not。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setIsClosed(val)

obj.setSeverity(severity)

绑定状态: 已绑定

Python 调用: obj.setSeverity(severity)

This function sets the severity attribute of this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setSeverity(severity)

obj.setPoints(points)

绑定状态: 已绑定

Python 调用: obj.setPoints(points)

This function sets the pointArray of this marker to the value specified。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setPoints(points)

obj.setMsg(msg)

绑定状态: 已绑定

Python 调用: obj.setMsg(msg)

This function sets the message string associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setMsg(msg)

obj.setShortMsg(shortMsg)

绑定状态: 已绑定

Python 调用: obj.setShortMsg(shortMsg)

This function sets the short message string associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setShortMsg(shortMsg)

obj.setTool(tool)

绑定状态: 已绑定

Python 调用: obj.setTool(tool)

This function sets the tool string associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setTool(tool)

obj.setDeleteWhen(deleteWhen)

绑定状态: 已绑定

Python 调用: obj.setDeleteWhen(deleteWhen)

This function changes the deleteWhen attribute of this marker to the specified deleteWhen value。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.setDeleteWhen(deleteWhen)

obj.getObjects()

绑定状态: 已绑定

Python 调用: obj.getObjects()

This function returns the collection of objects associated with this marker。

Python 示例

from oapy._oa import _design

# assume obj is a oaMarker
obj.getObjects()

_design.oaMarker.create(block, points, msg, shortMsg, tool, isVisible, isClosed, severity, deleteWhen=oacDeleteOnFirst)

绑定状态: 已绑定

Python 调用: _design.oaMarker.create(block, points, msg, shortMsg, tool, isVisible, isClosed, severity, deleteWhen=oacDeleteOnFirst)

This function creates a new marker in the specified block with the given attributes。 There is no check if a marker already exists with the specified attributes。

Python 示例

from oapy._oa import _design

_design.oaMarker.create(block, points, msg, shortMsg, tool, isVisible, isClosed, severity, deleteWhen=oacDeleteOnFirst)