Home       Trees       Indices       Help   
Module fmeobjects :: Class FMESolid
[hide private]
[frames] | no frames]

Class FMESolid

 object --+    
          |    
FMEGeometry --+
              |
             FMESolid
Known Subclasses:

init()

FMESolid is an abstract class. It cannot be created directly.

Instance Methods [hide private]
 
__init__()
x.__init__(...) initializes x; see help(type(x)) for signature
int
getAppearanceReference(front)
This method returns the appearance reference within the Library associated with this solid.
FMEMultiCurve or None
getAsWireFrame()
Returns the wireframe of the solid as a FMEMultiCurve.
None
offset(offsetPoint)
Offsets the solid by the coords specified by 'offsetPoint'.
None
reverse()
This reverses the order of the solid's points.
None
rotate2D(center, angle)
Rotates this solid about the z-axis by the specified angle, in degrees.The rotation is performed relative to the center specified.
None
scale(xScale, yScale, zScale)
Scale the feature by the given amounts.
None
setAppearanceReference(appearanceRef, front)
This method associates an appearance within the Library with this solid.

Inherited from FMEGeometry: __getObject__, __new__, boundingBox, boundingCube, bounds, clearMeasures, copyAttributesFromFeature, copyNameFromGeometry, copyTraitsFromGeometry, copyTraitsToFeature, deleteName, force2D, force3D, getArea, getMeasureNames, getName, getTrait, getTraitNames, getTraitNullMissingAndType, getTraitType, hasMeasures, hasName, is3D, isCollection, measureExists, removeMeasure, removeTraits, renameMeasure, setName, setTrait, setTraitNullWithType

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__()
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

getAppearanceReference(front)

 

This method returns the appearance reference within the Library associated with this solid. The front parameter controls whether this query should return the front or the back appearance reference. Both can be fetched independently. If this solid is a regular solid with no geometry instance, a FMEException will be thrown.

Parameters:
  • front (bool) - Indicates whether the appearance reference should be fetched for the front or back.
Returns: int
The unique appearance reference for this appearance.
Raises:
  • FMEException - An exception is raised if an error occurred or this solid is a regular solid with no geometry instance.

getAsWireFrame()

 

Returns the wireframe of the solid as a FMEMultiCurve. None is returned if a wireframe cannot be generated.

Returns: FMEMultiCurve or None
The wireframe of the solid as a FMEMultiCurve

offset(offsetPoint)

 

Offsets the solid by the coords specified by 'offsetPoint'.

Parameters:
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

rotate2D(center, angle)

 

Rotates this solid about the z-axis by the specified angle, in degrees.The rotation is performed relative to the center specified. A positive angle corresponds to a counter-clockwise rotation, when looking down onto the XY-plane.

Parameters:
  • center (FMEPoint) - The center point of the solid.
  • angle (float) - The angle by which the solid is rotated.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

scale(xScale, yScale, zScale)

 

Scale the feature by the given amounts.

Parameters:
  • xScale (float) - The value to scale x by.
  • yScale (float) - The value to scale y by.
  • zScale (float) - The value to scale z by.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred.

setAppearanceReference(appearanceRef, front)

 

This method associates an appearance within the Library with this solid. This is done by passing in the unique appearance reference for this appearance. Subsequent calls to this method on the same side, will override the previous appearance used with the new appearance passed in. An appearance reference of '0' represents the default appearance. Interpretation of the default appearance is left to the consumer of this geometry. When set at this FMESolid level, the appearance represents the default appearance to apply when the contained surfaces use the default appearance instead of a specific appearance. Contained surfaces may be found within nested solids, geometry instances that reference geometries containing surfaces, or as surfaces or multi-surfaces. The second parameter controls whether this action should take place on the front of the contained surfaces or the back. Both can be set independently. The appearanceRef should be a valid reference to a definition stored in the FMELibrary. If the reference was not found in the library, it will still attach the reference to the instance, but will throw a FMEException. This is an unhealthy situation as it represents a 'dangling reference'.

Parameters:
  • appearanceRef (int) - The unique appearance reference for this appearance.
  • front (bool) - Boolean indicting whether the appearance reference should be set for the front or back of the solid.
Returns: None
Raises:
  • FMEException - An exception is raised if an error occurred or the reference was not found in the library and a dangling reference was attached.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Thu Nov 26 19:10:16 2015 http://epydoc.sourceforge.net