[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [54566] branches/soc-2008-mxcurioni: Freestyle Python API improvements - part 3.

Tamito Kajiyama rd6t-kjym at asahi-net.or.jp
Fri Feb 15 00:48:35 CET 2013


Revision: 54566
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=54566
Author:   kjym3
Date:     2013-02-14 23:48:34 +0000 (Thu, 14 Feb 2013)
Log Message:
-----------
Freestyle Python API improvements - part 3.

Major API updates were made to address code review comments.
This revision mostly focuses on Python wrappers of C++ 0D and 1D elements (i.e.,
Interface0D and Interface1D, as well as their subclasses).

* Most getter/setter methods were reimplemented as attributes using PyGetSetDef.
Vector attributes are now implemented based on mathutils callbacks.  Boolean
attributes now only accept boolean values.

* The __getitem__ method was removed and the Sequence protocol was used instead.

* The naming of methods and attributes was fixed to follow the naming conventions
of the Blender Python API (i.e., lower case + underscores for methods and attributes,
and CamelCase for classes).  Some naming inconsistency within the Freestyle Python
API was also addressed.

* The Freestyle API had a number of method names including prefix/suffix "A" and
"B", and their meanings were inconsistent (i.e., referring to different things
depending on the classes).  The names with these two letters were replaced with
more straightforward names.  Also some attribute names were changed so as to indicate
the type of the value (e.g., FEdge.next_fedge instead of FEdge.next_edge) in line
with other names explicitly indicating what the value is (e.g., SVertex.viewvertex).

* In addition, some code clean-up was done in both C++ and Python.

Notes:

In summary, the following irregular naming changes were made through this revision
(those resulting from regular changes of naming conventions are not listed):

- CurvePoint: {A,B} --> {first,second}_svertex
- FEdge: vertex{A,B} --> {first,second}_svertex
- FEdge: {next,previous}Edge --> {next,previous}_fedge
- FEdgeSharp: normal{A,B} --> normal_{right,left}
- FEdgeSharp: {a,b}FaceMark --> face_mark_{right,left}
- FEdgeSharp: {a,b}Material --> material_{right,left}
- FEdgeSharp: {a,b}MaterialIndex --> material_index_{right,left}
- FrsCurve: empty --> is_empty
- FrsCurve: nSegments --> segments_size
- TVertex: mate() --> get_mate()
- ViewEdge: fedge{A,B} --> {first,last}_fedge
- ViewEdge: setaShape, aShape --> occlude
- ViewEdge: {A,B} --> {first,last}_viewvertex
- ViewMap: getScene3dBBox --> scene_bbox

Modified Paths:
--------------
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/ChainingIterators.py
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/Functions0D.py
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/PredicatesB1D.py
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/PredicatesU0D.py
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/PredicatesU1D.py
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/parameter_editor.py
    branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/shaders.py
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Id.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Interface0D.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_Interface1D.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_SShape.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_ViewMap.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/BPy_ViewShape.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.h
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface0D/BPy_ViewVertex.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.h
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp
    branches/soc-2008-mxcurioni/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.h

Modified: branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/ChainingIterators.py
===================================================================
--- branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/ChainingIterators.py	2013-02-14 21:40:29 UTC (rev 54565)
+++ branches/soc-2008-mxcurioni/release/scripts/freestyle/style_modules/ChainingIterators.py	2013-02-14 23:48:34 UTC (rev 54566)
@@ -44,10 +44,10 @@
 		it = AdjacencyIterator(iter)
 		tvertex = self.getVertex()
 		if type(tvertex) is TVertex:
-			mateVE = tvertex.mate(self.getCurrentEdge())
-			while(it.isEnd() == 0):
+			mateVE = tvertex.get_mate(self.getCurrentEdge())
+			while not it.isEnd():
 				ve = it.getObject()
-				if(ve.getId() == mateVE.getId() ):
+				if ve.id == mateVE.id:
 					winner = ve
 					break
 				it.increment()
@@ -55,24 +55,24 @@
 			## case of NonTVertex
 			natures = [Nature.SILHOUETTE,Nature.BORDER,Nature.CREASE,Nature.SUGGESTIVE_CONTOUR,Nature.VALLEY,Nature.RIDGE]
 			for i in range(len(natures)):
-				currentNature = self.getCurrentEdge().getNature()
-				if(natures[i] & currentNature):
+				currentNature = self.getCurrentEdge().nature
+				if (natures[i] & currentNature) != 0:
 					count=0
-					while(it.isEnd() == 0):
+					while not it.isEnd():
 						visitNext = 0
-						oNature = it.getObject().getNature()
-						if(oNature & natures[i] != 0):
-							if(natures[i] != oNature):
+						oNature = it.getObject().nature
+						if (oNature & natures[i]) != 0:
+							if natures[i] != oNature:
 								for j in range(i):
-									if(natures[j] & oNature != 0):
+									if (natures[j] & oNature) != 0:
 										visitNext = 1
 										break
-								if(visitNext != 0):
+								if visitNext != 0:
 									break	 
 							count = count+1
 							winner = it.getObject()
 						it.increment()
-					if(count != 1):
+					if count != 1:
 						winner = None
 					break
 		return winner
@@ -96,10 +96,10 @@
 		it = AdjacencyIterator(iter)
 		tvertex = self.getVertex()
 		if type(tvertex) is TVertex:
-			mateVE = tvertex.mate(self.getCurrentEdge())
-			while(it.isEnd() == 0):
+			mateVE = tvertex.get_mate(self.getCurrentEdge())
+			while not it.isEnd():
 				ve = it.getObject()
-				if(ve.getId() == mateVE.getId() ):
+				if ve.id == mateVE.id:
 					winner = ve
 					break
 				it.increment()
@@ -107,28 +107,28 @@
 			## case of NonTVertex
 			natures = [Nature.SILHOUETTE,Nature.BORDER,Nature.CREASE,Nature.SUGGESTIVE_CONTOUR,Nature.VALLEY,Nature.RIDGE]
 			for i in range(len(natures)):
-				currentNature = self.getCurrentEdge().getNature()
-				if(natures[i] & currentNature):
+				currentNature = self.getCurrentEdge().nature
+				if (natures[i] & currentNature) != 0:
 					count=0
-					while(it.isEnd() == 0):
+					while not it.isEnd():
 						visitNext = 0
-						oNature = it.getObject().getNature()
+						oNature = it.getObject().nature
 						ve = it.getObject()
-						if(ve.getId() == self.getCurrentEdge().getId()):
+						if ve.id == self.getCurrentEdge().id:
 							it.increment()
 							continue
-						if(oNature & natures[i] != 0):
-							if(natures[i] != oNature):
+						if (oNature & natures[i]) != 0:
+							if natures[i] != oNature:
 								for j in range(i):
-									if(natures[j] & oNature != 0):
+									if (natures[j] & oNature) != 0:
 										visitNext = 1
 										break
-								if(visitNext != 0):
+								if visitNext != 0:
 									break	 
 							count = count+1
 							winner = ve
 						it.increment()
-					if(count != 1):
+					if count != 1:
 						winner = None
 					break
 		return winner
@@ -146,14 +146,14 @@
 		self._isInSelection = 1
 
 	def checkViewEdge(self, ve, orientation):
-		if(orientation != 0):
-			vertex = ve.B()
+		if orientation != 0:
+			vertex = ve.second_svertex()
 		else:
-			vertex = ve.A()
+			vertex = ve.first_svertex()
 		it = AdjacencyIterator(vertex,1,1)
-		while(it.isEnd() == 0):
+		while not it.isEnd():
 			ave = it.getObject()
-			if(self._isExternalContour(ave)):
+			if self._isExternalContour(ave):
 				return 1
 			it.increment()
 		print("pyExternlContourChainingIterator : didn't find next edge")
@@ -161,23 +161,23 @@
 	def traverse(self, iter):
 		winner = None
 		it = AdjacencyIterator(iter)
-		while(it.isEnd() == 0):
+		while not it.isEnd():
 			ve = it.getObject()
-			if(self._isExternalContour(ve)):
-				if (ve.getTimeStamp() == GetTimeStampCF()):
+			if self._isExternalContour(ve):
+				if ve.time_stamp == GetTimeStampCF():
 					winner = ve
 			it.increment()
 		
 		self._nEdges = self._nEdges+1
-		if(winner == None):
+		if winner is None:
 			orient = 1
 			it = AdjacencyIterator(iter)
-			while(it.isEnd() == 0):
+			while not it.isEnd():
 				ve = it.getObject()
-				if(it.isIncoming() != 0):
+				if it.isIncoming() != 0: # FIXME
 					orient = 0
 				good = self.checkViewEdge(ve,orient)
-				if(good != 0):
+				if good != 0:
 					winner = ve
 				it.increment()
 		return winner
@@ -198,10 +198,10 @@
 		it = AdjacencyIterator(iter)
 		tvertex = self.getVertex()
 		if type(tvertex) is TVertex:
-			mateVE = tvertex.mate(self.getCurrentEdge())
-			while(it.isEnd() == 0):
+			mateVE = tvertex.get_mate(self.getCurrentEdge())
+			while not it.isEnd():
 				ve = it.getObject()
-				if(ve.getId() == mateVE.getId() ):
+				if ve.id == mateVE.id:
 					winner = ve
 					break
 				it.increment()
@@ -209,33 +209,33 @@
 			## case of NonTVertex
 			natures = [Nature.SILHOUETTE,Nature.BORDER,Nature.CREASE,Nature.SUGGESTIVE_CONTOUR,Nature.VALLEY,Nature.RIDGE]
 			for i in range(len(natures)):
-				currentNature = self.getCurrentEdge().getNature()
-				if(natures[i] & currentNature):
+				currentNature = self.getCurrentEdge().nature
+				if (natures[i] & currentNature) != 0:
 					count=0
-					while(it.isEnd() == 0):
+					while not it.isEnd():
 						visitNext = 0
-						oNature = it.getObject().getNature()
+						oNature = it.getObject().nature
 						ve = it.getObject()
-						if(ve.getId() == self.getCurrentEdge().getId()):
+						if ve.id == self.getCurrentEdge().id:
 							it.increment()
 							continue
-						if(oNature & natures[i] != 0):
-							if(natures[i] != oNature):
+						if (oNature & natures[i]) != 0:
+							if (natures[i] != oNature) != 0:
 								for j in range(i):
-									if(natures[j] & oNature != 0):
+									if (natures[j] & oNature) != 0:
 										visitNext = 1
 										break
-								if(visitNext != 0):
+								if visitNext != 0:
 									break	 
 							count = count+1
 							winner = ve
 						it.increment()
-					if(count != 1):
+					if count != 1:
 						winner = None
 					break
-		if(winner == None):
+		if winner is None:
 			winner = self.getCurrentEdge()
-		if(winner.getChainingTimeStamp() == self._timeStamp):
+		if winner.chaining_time_stamp == self._timeStamp:
 			winner = None
 		return winner
 
@@ -257,16 +257,16 @@
 	def traverse(self, iter):
 		winner = None
 		it = AdjacencyIterator(iter)
-		while(it.isEnd() == 0):
+		while not it.isEnd():
 			ve = it.getObject()
-			if(ve.getId() == self.getCurrentEdge().getId()):
+			if ve.id == self.getCurrentEdge().id:
 				it.increment()
 				continue
 			winner = ve
 			it.increment()
-		if(winner == None):
+		if winner is None:
 			winner = self.getCurrentEdge()
-		if(winner.getChainingTimeStamp() == self._timeStamp):
+		if winner.chaining_time_stamp == self._timeStamp:
 			return None
 		return winner
 
@@ -290,16 +290,16 @@
 	def traverse(self, iter):
 		winner = None
 		winnerOrientation = 0
-		print(self.getCurrentEdge().getId().getFirst(), self.getCurrentEdge().getId().getSecond())
+		print(self.getCurrentEdge().id.first, self.getCurrentEdge().id.second)
 		it = AdjacencyIterator(iter)
 		tvertex = self.getVertex()
 		if type(tvertex) is TVertex:
-			mateVE = tvertex.mate(self.getCurrentEdge())
-			while(it.isEnd() == 0):
+			mateVE = tvertex.get_mate(self.getCurrentEdge())
+			while not it.isEnd():
 				ve = it.getObject()
-				if(ve.getId() == mateVE.getId() ):
+				if ve.id == mateVE.id:
 					winner = ve
-					if(it.isIncoming() == 0):
+					if it.isIncoming() == 0: # FIXME
 						winnerOrientation = 1
 					else:
 						winnerOrientation = 0
@@ -309,52 +309,52 @@
 			## case of NonTVertex
 			natures = [Nature.SILHOUETTE,Nature.BORDER,Nature.CREASE,Nature.SUGGESTIVE_CONTOUR,Nature.VALLEY,Nature.RIDGE]
 			for nat in natures:
-				if(self.getCurrentEdge().getNature() & nat != 0):
+				if (self.getCurrentEdge().nature & nat) != 0:
 					count=0
-					while(it.isEnd() == 0):
+					while not it.isEnd():
 						ve = it.getObject()
-						if(ve.getNature() & nat != 0):
+						if (ve.nature & nat) != 0:
 							count = count+1
 							winner = ve
-							if(it.isIncoming() == 0):
+							if it.isIncoming() == 0: # FIXME
 								winnerOrientation = 1
 							else:
 								winnerOrientation = 0
 						it.increment()
-					if(count != 1):
+					if count != 1:
 						winner = None
 					break
-		if(winner != None):
+		if winner is not None:
 			# check whether this edge was part of the selection
-			if(winner.getTimeStamp() != GetTimeStampCF()):
-				#print("---", winner.getId().getFirst(), winner.getId().getSecond())
+			if winner.time_stamp != GetTimeStampCF():
+				#print("---", winner.id.first, winner.id.second)
 				# if not, let's check whether it's short enough with
 				# respect to the chain made without staying in the selection
 				#------------------------------------------------------------
 				# Did we compute the prospective chain length already ?
-				if(self._length == 0):
+				if self._length == 0:
 					#if not, let's do it
 					_it = pyChainSilhouetteGenericIterator(0,0)
 					_it.setBegin(winner)
 					_it.setCurrentEdge(winner)
 					_it.setOrientation(winnerOrientation)
 					_it.init()
-					while(_it.isEnd() == 0):
+					while not _it.isEnd():
 						ve = _it.getObject()
-						#print("--------", ve.getId().getFirst(), ve.getId().getSecond())
-						self._length = self._length + ve.getLength2D()
+						#print("--------", ve.id.first, ve.id.second)
+						self._length = self._length + ve.length_2d
 						_it.increment()
-						if(_it.isBegin() != 0):
+						if _it.isBegin():
 							break;
 					_it.setBegin(winner)
 					_it.setCurrentEdge(winner)
 					_it.setOrientation(winnerOrientation)
-					if(_it.isBegin() == 0):
+					if not _it.isBegin():
 						_it.decrement()
-						while ((_it.isEnd() == 0) and (_it.isBegin() == 0)):
+						while (not _it.isEnd()) and (not _it.isBegin()):
 							ve = _it.getObject()

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list