\(\renewcommand\AA{\unicode{x212B}}\)
ObjComponent¶
This is a Python binding to the C++ class Mantid::Geometry::ObjComponent.
bases: mantid.geometry.IObjComponent
, mantid.geometry.Component
- class mantid.geometry.ObjComponent¶
- getBoolParameter((Component)self, (str)pname[, (bool)recursive=True]) std_vector_bool ¶
- getDescription((Component)self) str : ¶
Return the description of current parameterized component
- getDistance((IComponent)self, (IComponent)other) float : ¶
Returns the distance, in metres, between this and the given component
- getFullName((IComponent)self) str : ¶
Returns full path name of component
- getIntParameter((Component)self, (str)pname[, (bool)recursive=True]) std_vector_int ¶
- getName((IComponent)self) str : ¶
Returns the name of the component
- getNumberParameter((Component)self, (str)pname[, (bool)recursive=True]) std_vector_dbl ¶
- getParameterNames((Component)self[, (bool)recursive=True]) std_set_str ¶
- getPos((IComponent)self) V3D : ¶
Returns the absolute position of the component
- getPositionParameter((Component)self, (str)pname[, (bool)recursive=True]) std_vector_v3d ¶
- getRelativeRot((IComponent)self) Quat : ¶
Returns the relative rotation as a Quat
- getRotationParameter((Component)self, (str)pname[, (bool)recursive=True]) std_vector_quat ¶
- getShortDescription((Component)self) str : ¶
Return the short description of current parameterized component
- getStringParameter((Component)self, (str)pname[, (bool)recursive=True]) std_vector_str ¶
- setDescription((Component)self, (str)descr) None : ¶
Set component’s description, works only if the component is parameterized component
- shape((IObjComponent)self) IObject : ¶
Get the object that represents the physical shape of this component
- type((IComponent)self) str : ¶
Returns the type of the component represented as a string