Plane

Inheritance diagram

Classes

Plane

class ORSModel.ors.Plane

Bases: Shape2D

Plane manipulation services.

copy(self) → ORSModel.ors.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) → ORSModel.ors.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)

Initializes the plane from 3 points.

Parameters:

• point0 (ORSModel.ors.Vector3) – The first point (an Vector3)

• point1 (ORSModel.ors.Vector3) – The second point (an Vector3)

• point2 (ORSModel.ors.Vector3) – The third point (an Vector3)

fromNPointsLeastMeanSquares(self, aPointCollection: ORSModel.ors.SequenceableCollection)

Parameters:

aPointCollection (ORSModel.ors.SequenceableCollection) – A sequence of points coordinates.

fromPointAndNormal(self, point: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3)

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

Parameters:

• point (ORSModel.ors.Vector3) – The point of origin (an Vector3)

• normal (ORSModel.ors.Vector3) – The normal vector (an Vector3)

getA(self) → float

Gets the a coefficient of the plane.

Note

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

See also

ORSModel.ors.Plane.getB(), ORSModel.ors.Plane.getC(), ORSModel.ors.Plane.getD()

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.

See also

ORSModel.ors.Plane.getA(), ORSModel.ors.Plane.getC(), ORSModel.ors.Plane.getD()

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.

See also

ORSModel.ors.Plane.getA(), ORSModel.ors.Plane.getB(), ORSModel.ors.Plane.getD()

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.

See also

ORSModel.ors.Plane.getA(), ORSModel.ors.Plane.getB(), ORSModel.ors.Plane.getC()

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) → ORSModel.ors.Vector3

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)

Parameters:

• aLine (ORSModel.ors.Line) – a line (a Line)

• aVector3Output (ORSModel.ors.Vector3) – a vector (a Vector3) to fill

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

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) → ORSModel.ors.Line

Parameters:

plane (ORSModel.ors.Plane) –

Returns:

output (ORSModel.ors.Line) –

getIntersectionWithPlanes(self, plane1: ORSModel.ors.Plane, plane2: ORSModel.ors.Plane) → ORSModel.ors.Vector3

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

Parameters:

• plane1 (ORSModel.ors.Plane) –

• plane2 (ORSModel.ors.Plane) –

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) → ORSModel.ors.Vector3

Returns the normal of the plane.

Returns:

output (ORSModel.ors.Vector3) – A vector (an Vector3)

getPointOnPlaneClosestToOrigin(self) → ORSModel.ors.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) → ORSModel.ors.Vector3

Parameters:

point (ORSModel.ors.Vector3) –

Returns:

output (ORSModel.ors.Vector3) –

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → ORSModel.ors.Plane

Parameters:

• axisOfRotation (ORSModel.ors.Vector3) –

• rotationCenter (ORSModel.ors.Vector3) –

• angle (float) –

Returns:

output (ORSModel.ors.Plane) –

getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → ORSModel.ors.Plane

Parameters:

point (ORSModel.ors.Vector3) –

Returns:

output (ORSModel.ors.Plane) –

none() → Plane

Returns:

output (Plane) –

rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float)

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)

Sets the a coefficient of the plane.

Note

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

See also

ORSModel.ors.Plane.setB(), ORSModel.ors.Plane.setC(), ORSModel.ors.Plane.setD()

Parameters:

a (float) – The a coefficient of the plane (a double)

setB(self, b: float)

Sets the b coefficient of the plane.

Note

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

See also

ORSModel.ors.Plane.setA(), ORSModel.ors.Plane.setC(), ORSModel.ors.Plane.setD()

Parameters:

b (float) – The b coefficient of the plane (a double)

setC(self, c: float)

Sets the c coefficient of the plane.

Note

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

See also

ORSModel.ors.Plane.setA(), ORSModel.ors.Plane.setB(), ORSModel.ors.Plane.setD()

Parameters:

c (float) – The c coefficient of the plane (a double)

setD(self, d: float)

Sets the d coefficient of the plane.

Note

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

See also

ORSModel.ors.Plane.setA(), ORSModel.ors.Plane.setB(), ORSModel.ors.Plane.setC()

Parameters:

d (float) – The d coefficient of the plane (a double)

translateToIncludePoint(self, point: ORSModel.ors.Vector3)

Parameters:

point (ORSModel.ors.Vector3) –

Shape2D

class ORSModel.ors.Shape2D

Bases: Shape

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

none() → Shape2D

Returns:

output (Shape2D) –

Shape

class ORSModel.ors.Shape

Bases: Unmanaged

Shape manipulation services.

copy(self) → ORSModel.ors.Unmanaged

Gets a copy of the receiver.

Returns:

output (ORSModel.ors.Unmanaged) – a shape

getCanBeUsedForProjection(self) → bool

Returns:

output (bool) –

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) → ORSModel.ors.Shape

Parameters:

• axisOfRotation (ORSModel.ors.Vector3) –

• rotationCenter (ORSModel.ors.Vector3) –

• angle (float) –

Returns:

output (ORSModel.ors.Shape) –

getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → ORSModel.ors.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)

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)

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: ORSBaseClass

Abstract class for objects that are not managed by the core library. Unmanaged objects are transient objects.

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) – an unmanaged 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) → ORSModel.ors.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)

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

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

An abstract class from which all objects issued from the ORS Core Library inherit.

getPythonTraceBack() → List[str]

Set the python traceback for a call from python.

Returns:

output (List[str]) –

isManaged(self) → bool

Returns:

output (bool) –

isNone(self) → bool

Returns:

output (bool) –

setPythonTraceBack(tb: List[str])

Set the python traceback for a call from python.

Parameters:

tb (List[str]) –