Removed incorrect apostrophies.
This commit is contained in:
committed by
Yorik van Havre
parent
390a093a67
commit
9f4348e00a
@@ -163,7 +163,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
"""The Arch Component object.
|
||||
|
||||
Acts as a base for all other Arch objects, such as Arch walls and Arch
|
||||
structures. It's properties and behaviours are common to all Arch objects.
|
||||
structures. Its properties and behaviours are common to all Arch objects.
|
||||
|
||||
You can learn more about Arch Components, and the purpose of Arch
|
||||
Components here: https://wiki.freecadweb.org/Arch_Component
|
||||
@@ -186,7 +186,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
self.Type = "Component"
|
||||
|
||||
def setProperties(self, obj):
|
||||
"""Gives the component it's component specific properties, such as material.
|
||||
"""Gives the component its component specific properties, such as material.
|
||||
|
||||
You can learn more about properties here:
|
||||
https://wiki.freecadweb.org/property
|
||||
@@ -276,7 +276,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
|
||||
If "Placement" has changed, it records the old placement, so that
|
||||
.onChanged() can compare between the old and new placement, and move
|
||||
it's children accordingly.
|
||||
its children accordingly.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
@@ -366,7 +366,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
"""Gets a height value from hosts.
|
||||
|
||||
Recursively crawls hosts until it finds a Floor or BuildingPart, then
|
||||
returns the value of it's Height property.
|
||||
returns the value of its Height property.
|
||||
|
||||
Returns
|
||||
-------
|
||||
@@ -451,7 +451,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
|
||||
With this copy, it gets the <Part.Face> the shape was originally
|
||||
extruded from, the <Base.Vector> of the extrusion, and the
|
||||
<Base.Placement> needed to move the copy back to it's original
|
||||
<Base.Placement> needed to move the copy back to its original
|
||||
location/orientation. It will return this data as a tuple.
|
||||
|
||||
If it encounters an object derived from a <Part::Multifuse>, it will
|
||||
@@ -551,13 +551,13 @@ class Component(ArchIFC.IfcProduct):
|
||||
def rebase(self,shape,hint=None):
|
||||
"""Copies a shape to the (0,0,0) origin.
|
||||
|
||||
Creates a copy of a shape, such that it's center of mass is in the
|
||||
Creates a copy of a shape, such that its center of mass is in the
|
||||
(0,0,0) origin.
|
||||
|
||||
TODO Determine the way the shape is rotated by this method.
|
||||
|
||||
Returns the copy of the shape, and the <Base.Placement> needed to move
|
||||
the copy back to it's original location/orientation.
|
||||
the copy back to its original location/orientation.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
@@ -766,7 +766,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
return base
|
||||
|
||||
def spread(self,obj,shape,placement=None):
|
||||
"""Copies the object to it's Axis's points.
|
||||
"""Copies the object to its Axis's points.
|
||||
|
||||
If the object has the "Axis" property assigned, this method creates a
|
||||
copy of the shape for each point on the object assigned as the "Axis".
|
||||
@@ -812,7 +812,7 @@ class Component(ArchIFC.IfcProduct):
|
||||
"""Checks if a placement is *almost* zero.
|
||||
|
||||
Check if a <Base.Placement>'s displacement from (0,0,0) is almost zero,
|
||||
and if the angle of it's rotation about it's axis is almost zero.
|
||||
and if the angle of its rotation about its axis is almost zero.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
@@ -982,12 +982,12 @@ class Component(ArchIFC.IfcProduct):
|
||||
obj.PerimeterLength = self.flatarea.Faces[0].OuterWire.Length
|
||||
|
||||
def isStandardCase(self,obj):
|
||||
"""Determines if the component is a standard case of it's IFC type.
|
||||
"""Determines if the component is a standard case of its IFC type.
|
||||
|
||||
Not all IFC types have a standard case.
|
||||
|
||||
If an object is a standard case or not varies between the different
|
||||
types. Each type has it's own rules to define what is a standard case.
|
||||
types. Each type has its own rules to define what is a standard case.
|
||||
|
||||
Rotated objects, or objects with Additions or Subtractions are not
|
||||
standard cases.
|
||||
@@ -1075,7 +1075,7 @@ class ViewProviderComponent:
|
||||
self.setProperties(vobj)
|
||||
|
||||
def setProperties(self,vobj):
|
||||
"""Gives the component view provider it's component view provider specific properties.
|
||||
"""Gives the component view provider its component view provider specific properties.
|
||||
|
||||
You can learn more about properties here:
|
||||
https://wiki.freecadweb.org/property
|
||||
@@ -1445,9 +1445,9 @@ class ViewProviderComponent:
|
||||
return False
|
||||
|
||||
def colorize(self,obj,force=False):
|
||||
"""If an object is a clone, sets it it to copy the color of it's parent.
|
||||
"""If an object is a clone, sets it it to copy the color of its parent.
|
||||
|
||||
Will only change the color of the clone if the clone and it's parent
|
||||
Will only change the color of the clone if the clone and its parent
|
||||
have colors that are distinguishably different from each other.
|
||||
|
||||
Parameters
|
||||
@@ -1758,7 +1758,7 @@ class ComponentTaskPanel:
|
||||
return QtGui.QIcon(":/icons/Tree_Part.svg")
|
||||
|
||||
def update(self):
|
||||
"""Populates the treewidget with it's various items.
|
||||
"""Populates the treewidget with its various items.
|
||||
|
||||
Checks if the object being edited has attributes relevant to
|
||||
subobjects. IE: Additions, Subtractions, etc.
|
||||
@@ -2055,7 +2055,7 @@ class ComponentTaskPanel:
|
||||
dropdown, it adds a property with the property type selected in the
|
||||
dropdown.
|
||||
|
||||
This method can also be run standalone, outside it's function as a
|
||||
This method can also be run standalone, outside its function as a
|
||||
callback.
|
||||
|
||||
Unless otherwise specified, the property will be called "New property".
|
||||
|
||||
@@ -175,7 +175,7 @@ class _Floor(ArchIFC.IfcProduct):
|
||||
The Floor object.
|
||||
|
||||
Turns a <App::DocumentObjectGroupPython> into a floor object, then
|
||||
takes a list of objects to own as it's children.
|
||||
takes a list of objects to own as its children.
|
||||
"""
|
||||
|
||||
def __init__(self,obj):
|
||||
@@ -184,7 +184,7 @@ class _Floor(ArchIFC.IfcProduct):
|
||||
The floor can be based off either a group, or a python feature. Learn more
|
||||
about groups here: https://wiki.freecadweb.org/Std_Group
|
||||
|
||||
Adds the properties of a floor, and sets it's IFC type.
|
||||
Adds the properties of a floor, and sets its IFC type.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
@@ -257,7 +257,7 @@ class _Floor(ArchIFC.IfcProduct):
|
||||
def execute(self,obj):
|
||||
"""Method run when the object is recomputed.
|
||||
|
||||
Moves it's children if it's placement has changed since the previous
|
||||
Moves its children if its placement has changed since the previous
|
||||
recompute. Sets any child Walls and Structures to have the height of
|
||||
the floor if they have not Height value set.
|
||||
"""
|
||||
|
||||
@@ -215,7 +215,7 @@ class IfcRoot:
|
||||
https://wiki.freecadweb.org/Expressions
|
||||
|
||||
Does not add the attribute if the object has a property with the
|
||||
attribute's name. Also does not add the attribute if it's name is
|
||||
attribute's name. Also does not add the attribute if its name is
|
||||
RefLatitude, RefLongitude, or Name.
|
||||
|
||||
Parameters
|
||||
@@ -234,10 +234,10 @@ class IfcRoot:
|
||||
self.addIfcAttributeValueExpressions(obj, attribute)
|
||||
|
||||
def addIfcAttribute(self, obj, attribute):
|
||||
"""Adds an IFC type's attribute to the object, within it's properties.
|
||||
"""Adds an IFC type's attribute to the object, within its properties.
|
||||
|
||||
Adds the attribute's schema to the object's IfcData property, as an
|
||||
item under it's "attributes" array.
|
||||
item under its "attributes" array.
|
||||
|
||||
Also adds the attribute as a property of the object.
|
||||
|
||||
@@ -388,7 +388,7 @@ class IfcRoot:
|
||||
|
||||
Removes the property representing an IFC attribute, if it does not
|
||||
appear in the schema of the IFC type provided. Also, removes the
|
||||
property if it's attribute is an enum type, presumably for backwards
|
||||
property if its attribute is an enum type, presumably for backwards
|
||||
compatibility.
|
||||
|
||||
Learn more about IFC enums here:
|
||||
|
||||
@@ -136,13 +136,13 @@ class _Project(ArchIFC.IfcContext):
|
||||
"""The project object.
|
||||
|
||||
Takes a <Part::FeaturePython>, and turns it into a Project. Then takes a
|
||||
list of Arch sites to own as it's children.
|
||||
list of Arch sites to own as its children.
|
||||
"""
|
||||
|
||||
def __init__(self, obj):
|
||||
"""Initialises the project.
|
||||
|
||||
Adds the properties of a project, and sets it's IFC type.
|
||||
Adds the properties of a project, and sets its IFC type.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
@@ -538,7 +538,7 @@ class _Site(ArchIFC.IfcProduct):
|
||||
|
||||
The site must be based off a <Part::FeaturePython> object.
|
||||
|
||||
Adds the properties of a site, and sets it's IFC type.
|
||||
Adds the properties of a site, and sets its IFC type.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
@@ -793,10 +793,10 @@ class _ViewProviderSite:
|
||||
self.setProperties(vobj)
|
||||
|
||||
def setProperties(self,vobj):
|
||||
"""Gives the site view provider it's site view provider specific properties.
|
||||
"""Gives the site view provider its site view provider specific properties.
|
||||
|
||||
These include solar diagram and compass data, dealing the orientation
|
||||
of the site, and it's orientation to the sun.
|
||||
of the site, and its orientation to the sun.
|
||||
|
||||
You can learn more about properties here: https://wiki.freecadweb.org/property
|
||||
"""
|
||||
|
||||
@@ -77,7 +77,7 @@ def makeWall(baseobj=None,height=None,length=None,width=None,align="Center",face
|
||||
Arch default if left empty.
|
||||
align: str, optional
|
||||
Either "Center", "Left", or "Right". Effects the alignment of the wall
|
||||
on it's baseline.
|
||||
on its baseline.
|
||||
face: int, optional
|
||||
The index number of a face on the given baseobj, to base the wall on.
|
||||
name: str, optional
|
||||
@@ -700,7 +700,7 @@ class _Wall(ArchComponent.Component):
|
||||
obj.IfcType = "Wall"
|
||||
|
||||
def setProperties(self, obj):
|
||||
"""Gives the wall it's wall specific properties, such as it's alignment.
|
||||
"""Gives the wall its wall specific properties, such as its alignment.
|
||||
|
||||
You can learn more about properties here:
|
||||
https://wiki.freecadweb.org/property
|
||||
@@ -1201,7 +1201,7 @@ class _Wall(ArchComponent.Component):
|
||||
# If the user has defined a specific face of the Base
|
||||
# object to build the wall from, extrude from that face,
|
||||
# and return the extrusion moved to (0,0,0), normal of the
|
||||
# face, and placement to move the extrusion back to it's
|
||||
# face, and placement to move the extrusion back to its
|
||||
# original position.
|
||||
elif obj.Face > 0:
|
||||
if len(obj.Base.Shape.Faces) >= obj.Face:
|
||||
|
||||
Reference in New Issue
Block a user