German Larrain avatar German Larrain committed f876604

VtkAdapter: added docstrings for '_set_object_transform_matrix' and '_create_transform_matrix'.

Comments (0)

Files changed (1)

ars/graphics/adapters.py

 
 	@staticmethod
 	def _set_object_transform_matrix(obj, transMat):
+		"""Set ``obj``'s pose according to the transform ``transMat``.
+
+		:param obj: object to be modified
+		:type obj: :class:`vtk.vtkProp3D`
+		:param transMat: homogeneous transform
+		:type transMat: :class:`vtk.vtkMatrix4x4`
+
+		"""
 		obj.PokeMatrix(transMat)
 
 	@staticmethod
 	def _create_transform_matrix(pos, rot):
-		"""
-		pos: a 3-tuple
-		rot: a 9-tuple
+		"""Create a homogeneous transform matrix valid for VTK.
+
+		:param pos: a size 3 vector, or 3x1 or 1x3 matrix
+		:type pos: tuple, :class:`numpy.ndarray` or None
+		:param rot: 3x3 or 9x1 rotation matrix
+		:type rot: tuple, :class:`numpy.ndarray` or None
+
+		:return: a VTK-valid transform matrix
+		:rtype: :class:`vtk.vtkMatrix4x4`
 
 		"""
 		t = gemut.Transform(pos, rot)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.