Plane

Inheritance diagram

Inheritance diagram of ORSModel.ors.Plane, ORSModel.ors.Shape2D, ORSModel.ors.Shape, ORSModel.ors.Unmanaged, ORSModel.ors.ORSBaseClass

Classes

Plane

class ORSModel.ors.Plane

Bases: ORSModel.ors.Shape2D

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

copy(self) → Plane

Copies a plane.

Note

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

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

Create aPlane from a python representation a static method.

Parameters:aPythonRepresentation (str) –
Returns:output (ORSModel.ors.Plane) –
from3Points(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3) → None

Initializes the plane from 3 points.

Parameters:
fromNPointsLeastMeanSquares(self, aPointCollection: ORSModel.ors.SequenceableCollection) → None

Gets the plane minimizing the sum of the squares distances from a set of (at least 3) points.

Parameters:aPointCollection (ORSModel.ors.SequenceableCollection) – A sequence of points coordinates.
fromPointAndNormal(self, point: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3) → None

Initializes the plane from an origin point and a normal vector.

Parameters:
getA(self) → float

Gets the a coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Returns:output (float) – The a coefficient of the plane (a double)
getB(self) → float

Gets the b coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Returns:output (float) – The b coefficient of the plane (a double)
getC(self) → float

Gets the c coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Returns:output (float) – The c coefficient of the plane (a double)
getClassNameStatic() → str

getClassNameStatic

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

Gets the d coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Returns:output (float) – The d coefficient of the plane (a double)
getDistanceFromPlane(self, plane: ORSModel.ors.Plane) → float

Computes the distance from another plane.

Parameters:plane (ORSModel.ors.Plane) – A plane (an Plane)
Returns:output (float) – the distance (a double)
getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float

Computes the distance from a point.

Parameters:point (ORSModel.ors.Vector3) – A point (an Vector3)
Returns:output (float) – the distance (a double)
getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → Vector3

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

Parameters:aLine (ORSModel.ors.Line) – a line (a Line)
Returns:output (ORSModel.ors.Vector3) – a vector (a Vector3) or NULL if not intersection
getIntersectionWithLineProvidingOutput(self, aLine: ORSModel.ors.Line, aVector3Output: ORSModel.ors.Vector3) → None

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

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → Vector3

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

Parameters:aLineSegment (ORSModel.ors.LineSegment) –
Returns:output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection
getIntersectionWithPlane(self, plane: ORSModel.ors.Plane) → Line
Parameters:plane (ORSModel.ors.Plane) –
Returns:output (ORSModel.ors.Line) –
getIntersectionWithPlanes(self, plane1: ORSModel.ors.Plane, plane2: ORSModel.ors.Plane) → Vector3

Return the point of the intersection of the provided planes and the receiver.

Parameters:
Returns:

output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection
getIsEqualTo(self, plane: ORSModel.ors.Plane) → bool

Verifies equality between the receiver and a given plane.

Parameters:plane (ORSModel.ors.Plane) –
Returns:output (bool) – TRUE if the argument plane is equal to the receiver, FALSE otherwise
getIsIntersectingLine(self, aLine: ORSModel.ors.Line) → bool

Gets if the receiver intersects the given line.

Parameters:aLine (ORSModel.ors.Line) – a line (a Line)
Returns:output (bool) – TRUE if the plane intersects the line, FALSE otherwise (a bool)
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)
getIsParallelWithPlane(self, plane: ORSModel.ors.Plane) → bool

Checks to see if a given plane is parallel to the received plane.

Parameters:plane (ORSModel.ors.Plane) – A plane (an Plnae)
Returns:output (bool) – TRUE if both planes are parallel, FALSE otherwise
getNormal(self) → Vector3

Returns the normal of the plane.

Returns:output (ORSModel.ors.Vector3) – A vector (an Vector3)
getPointOnPlaneClosestToOrigin(self) → Vector3

Returns the closest point to the origin of the plane.

Returns:output (ORSModel.ors.Vector3) – A point (an Vector3)
getProjectionOnPlane(self, point: ORSModel.ors.Vector3) → Vector3
Parameters:point (ORSModel.ors.Vector3) –
Returns:output (ORSModel.ors.Vector3) –
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Plane
Parameters:
Returns:

output (ORSModel.ors.Plane) –

getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → Plane
Parameters:point (ORSModel.ors.Vector3) –
Returns:output (ORSModel.ors.Plane) –
none() → Plane
Returns:output (Plane) –
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)
setA(self, a: float) → None

Sets the a coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Parameters:a (float) – The a coefficient of the plane (a double)
setB(self, b: float) → None

Sets the b coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Parameters:b (float) – The b coefficient of the plane (a double)
setC(self, c: float) → None

Sets the c coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Parameters:c (float) – The c coefficient of the plane (a double)
setD(self, d: float) → None

Sets the d coefficient of the plane.

Note

The general plane equation is ax + by + cz + dw = 0.

Parameters:d (float) – The d coefficient of the plane (a double)
translateToIncludePoint(self, point: ORSModel.ors.Vector3) → None
Parameters:point (ORSModel.ors.Vector3) –

Shape2D

class ORSModel.ors.Shape2D

Bases: ORSModel.ors.Shape

getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
none() → Shape2D
Returns:output (Shape2D) –

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]) –