Cylinder

Inheritance diagram

Inheritance diagram of ORSModel.ors.Cylinder, ORSModel.ors.Shape3D, ORSModel.ors.Shape, ORSModel.ors.Unmanaged, ORSModel.ors.ORSBaseClass

Classes

Cylinder

class ORSModel.ors.Cylinder

Bases: ORSModel.ors.Shape3D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

copy(self) → Cylinder

Copies aCylinder.

Note

The copied Cylinder has the same equation as the source Cylinder.

Returns:output (ORSModel.ors.Cylinder) – A new Cylinder (an Cylinder)
createFromPythonRepresentation(aPythonRepresentation: str) → Cylinder

Create aCylinder from a python representation a static method.

Parameters:aPythonRepresentation (str) –
Returns:output (ORSModel.ors.Cylinder) –
fromNPointsLeastMeanSquares(self, aPointCollection: ORSModel.ors.SequenceableCollection) → None

Sets the cylinder minimizing the sum of the squares distances from a set of (at leats 6) points.

Parameters:aPointCollection (ORSModel.ors.SequenceableCollection) –
getAxis(self) → Vector3

Returns the normal of theCylinder.

Returns:output (ORSModel.ors.Vector3) – A vector (an Vector3)
getCap1Center(self) → Vector3
Returns:output (ORSModel.ors.Vector3) –
getCap2Center(self) → Vector3
Returns:output (ORSModel.ors.Vector3) –
getCenter(self) → Vector3
Returns:output (ORSModel.ors.Vector3) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getHeight(self) → float

GetsCylinder Height.

Returns:output (float) – An Height (a double)
getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → LineSegment

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:aLine (ORSModel.ors.Line) –
Returns:output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → LineSegment

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:aLineSegment (ORSModel.ors.LineSegment) –
Returns:output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection
getIsEqualTo(self, Cylinder: ORSModel.ors.Cylinder) → bool

Verifies equality between the receiver and a givenCylinder.

Parameters:Cylinder (ORSModel.ors.Cylinder) –
Returns:output (bool) – TRUE if the argument Cylinder is equal to the receiver, FALSE otherwise
getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)
Returns:output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)
getRadius(self) → float
Returns:output (float) –
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Cylinder
Parameters:
Returns:

output (ORSModel.ors.Cylinder) –

getSurface(self) → float

GetsCylinder Surface.

Returns:output (float) – A Surface (a double)
getThetaOffset(self) → float
Returns:output (float) –
getVolume(self) → float

GetsCylinder Volume.

Returns:output (float) – A Volume (a double)
none() → Cylinder
Returns:output (Cylinder) –
rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

Applies a rotation to the receiver.

Note

The box is a right handed bounded referential.

Parameters:
  • axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3)
  • aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3)
  • angleInRadian (float) – an angle in radian (a double)
setCap1Center(self, aPoint: ORSModel.ors.Vector3) → None
Parameters:aPoint (ORSModel.ors.Vector3) –
setCap2Center(self, aPoint: ORSModel.ors.Vector3) → None
Parameters:aPoint (ORSModel.ors.Vector3) –
setCenter(self, aPoint: ORSModel.ors.Vector3) → None
Parameters:aPoint (ORSModel.ors.Vector3) –
setRadius(self, aRadius: float) → None
Parameters:aRadius (float) –
setThetaOffset(self, anOffset: float) → None
Parameters:anOffset (float) –
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None
Parameters:transformationMatrix (ORSModel.ors.Matrix4x4) –

Shape3D

class ORSModel.ors.Shape3D

Bases: ORSModel.ors.Shape

getCanBeUsedForProjection(self) → bool
Returns:output (bool) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getIsPointInside(self, aPosition: ORSModel.ors.Vector3) → bool

Verifies if a point is inside the shape.

Parameters:aPosition (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:output (bool) – TRUE if the point is inside the shape, FALSE otherwise
getIsPointInsideFromComponents(self, aPositionX: float, aPositionY: float, aPositionZ: float) → bool

Verifies if a point is inside the shape.

Parameters:
  • aPositionX (float) – a point X component (a double)
  • aPositionY (float) – a point Y component (a double)
  • aPositionZ (float) – a point Z component (a double)
Returns:

output (bool) – TRUE if the point is inside the shape, FALSE otherwise
getProjectionRectangle(self) → Rectangle
Returns:output (ORSModel.ors.Rectangle) –
none() → Shape3D
Returns:output (Shape3D) –

Shape

class ORSModel.ors.Shape

Bases: ORSModel.ors.Unmanaged

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2017

copy(self) → Unmanaged

Gets a copy of the receiver.

Returns:output (ORSModel.ors.Unmanaged) – a shape
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)
Returns:output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Shape
Parameters:
Returns:

output (ORSModel.ors.Shape) –

getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → Shape
Parameters:aMatrix (ORSModel.ors.Matrix4x4) –
Returns:output (ORSModel.ors.Shape) –
none() → Shape
Returns:output (Shape) –
rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float) → None

Applies a rotation to the receiver.

Note

The box is a right handed bounded referential.

Parameters:
  • axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3)
  • aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3)
  • angleInRadian (float) – an angle in radian (a double)
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None

Applies a transformation to the receiver.

Note

The transformation can include: translation, rotation and scaling.

Parameters:transformationMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSModel.ors.ORSBaseClass

brief_description: Abstract class for objects that are not managed by the core library. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

atomicLoad(sFilename: str) → Unmanaged

Creates an object from a file where an object was saved.

Parameters:sFilename (str) – path of the file to load
Returns:output (Unmanaged) – a managed object, or none() if the load fails
atomicSave(self, aFilename: str) → int

Saves the object to a file.

Parameters:aFilename (str) – path of the file to save
Returns:output (int) – 0 if successful, otherwise an error code
createFromPythonRepresentation(aPythonRepresentation: str) → Unmanaged

Create aUnmanaged Object from a python representation a static method.

Parameters:aPythonRepresentation (str) –
Returns:output (ORSModel.ors.Unmanaged) –
fromPythonRepresentation(self, aPythonRepresentation: str) → bool

Create aUnmanaged object from a Python string representation.

Parameters:aPythonRepresentation (str) – a Python evaluable string representation (a string)
Returns:output (bool) – TRUE if parsing worked, FALSE otherwise (a bool)
classmethod getAllSubclasses(outputCollection=None)
classmethod getClassDenomination()
static getClassFromProgId(progId)
getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:output (str) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getDataChecksum(self) → str
Returns:output (str) –
getIsInstanceOf(self, pProgId: str) → bool

Queries the object to know if it is an instance of a certain class.

Parameters:pProgId (str) –
Returns:output (bool) –
classmethod getIsSubclassOf(parentClass)
getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:output (str) –
isNone(self) → bool

Checks if the receiver is none.

Returns:output (bool) –
isNotNone(self) → bool

Checks if the receiver is not none.

Returns:output (bool) –
none() → Unmanaged
Returns:output (Unmanaged) –

ORSBaseClass

class ORSModel.ors.ORSBaseClass

brief_description: An abstract class from which all objects issued from the author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

getPythonTraceBack() → typing.List[str]

Set the python traceback for a call from python.

Returns:output (typing.List[str]) –
isManaged(self) → bool
Returns:output (bool) –
isNone(self) → bool
Returns:output (bool) –
setPythonTraceBack(tb: ORSModel.ors.typing.List[str]) → None

Set the python traceback for a call from python.

Parameters:tb (typing.List[str]) –