Class DPath (version 0.18)

Description: An path class

A path consists of an sequence of line segments forming the 'spine' of the path and a width. In addition, the starting point can be drawn back by a certain extent (the 'begin extension') and the end point can be pulled forward somewhat (by the 'end extension'). A path may have round ends for special purposes.

Class overview

Index

Method Overview

[static] DPath new	Default constructor: creates an empty (invalid) path with width 0
[static] DPath new( DPoint pts[ ], double width )	Constructor given the points of the path's spine and the width
[static] DPath new( DPoint pts[ ], double width, double bgn_ext, double end_ext )	Constructor given the points of the path's spine, the width and the extensions
[static] DPath new( DPoint pts[ ], double width, double bgn_ext, double end_ext, bool round )	Constructor given the points of the path's spine, the width, the extensions and the round end flag
[const] bool <( DPath p )	Less operator
[const] bool ==( DPath p )	Equality test
[const] bool !=( DPath p )	Inequality test
points=( DPoint p[ ] )	Set the points of the path
[const] yield DPoint each_point	Get the points that make up the path's spine
[const] unsigned int points	Get the number of points
width=( double )	Set the width
[const] double width	Get the width
bgn_ext=( double )	Set the begin extension
[const] double bgn_ext	Get the begin extension
end_ext=( double )	Set the end extension
[const] double end_ext	Get the end extension
round=( bool )	Set the 'round ends' flag
[const] bool is_round?	Tell, if the path has round ends
ref DPath move( DPoint p )	Moves the path.
[const] DPath moved( DPoint p )	Returns the moved path
[const] DPath transformed( DTrans t )	Transform the path.
[const] DPath transformed_cplx( DCplxTrans t )	Transform the path.
[const] string to_s	Convert to a string
[const] DSimplePolygon simple_polygon	Convert the path to a simple polygon
[const] DPolygon polygon	Convert the path to a polygon
[const] DBox bbox	Return the bounding box of the path
[static] DPath from_ipath( Path int_path )	Construct a floating-point coordinate path from an integer coordinate one
assign( DPath other )	Assign the contents of another object to self
[const] DPath dup	Creates a copy of self.
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

[const] bool !=( DPath p )

Description: Inequality test

p:	The object to compare against

[const] bool <( DPath p )

Description: Less operator

This operator is provided to establish some, not necessarily a certain sorting order

p:	The object to compare against

[const] bool ==( DPath p )

Description: Equality test

p:	The object to compare against

assign( DPath other )

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

[const] DBox bbox

Description: Return the bounding box of the path

[const] double bgn_ext

Description: Get the begin extension

bgn_ext=( double )

Description: Set the begin extension

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] DPath dup

Description: Creates a copy of self.

[const] yield DPoint each_point

Description: Get the points that make up the path's spine

[const] double end_ext

Description: Get the end extension

end_ext=( double )

Description: Set the end extension

[static] DPath from_ipath( Path int_path )

Description: Construct a floating-point coordinate path from an integer coordinate one

This method has been added in version 0.15.

[const] bool is_round?

Description: Tell, if the path has round ends

ref DPath move( DPoint p )

Description: Moves the path.

Moves the path by the given offset and returns the moved path. The path is overwritten.

p:	The distance to move the path.
returns:	The moved path.

[const] DPath moved( DPoint p )

Description: Returns the moved path

Moves the path by the given offset and returns the moved path. The path is not modified.

p:	The distance to move the path.
returns:	The moved path.

[static] DPath new( DPoint pts[ ], double width, double bgn_ext, double end_ext )
synonym: [static] DPath new_pwx( DPoint pts[ ], double width, double bgn_ext, double end_ext )

Description: Constructor given the points of the path's spine, the width and the extensions

pts:	The points forming the spine of the path
width:	The width of the path
bgn_ext:	The begin extension of the path
end_ext:	The end extension of the path

[static] DPath new( DPoint pts[ ], double width )
synonym: [static] DPath new_pw( DPoint pts[ ], double width )

Description: Constructor given the points of the path's spine and the width

pts:	The points forming the spine of the path
width:	The width of the path

[static] DPath new

Description: Default constructor: creates an empty (invalid) path with width 0

[static] DPath new( DPoint pts[ ], double width, double bgn_ext, double end_ext, bool round )
synonym: [static] DPath new_pwxr( DPoint pts[ ], double width, double bgn_ext, double end_ext, bool round )

Description: Constructor given the points of the path's spine, the width, the extensions and the round end flag

pts:	The points forming the spine of the path
width:	The width of the path
bgn_ext:	The begin extension of the path
end_ext:	The end extension of the path
round:	If this flag is true, the path will get rounded ends

[const] unsigned int points

Description: Get the number of points

points=( DPoint p[ ] )

Description: Set the points of the path

p:	An array of points to assign to the path's spine

[const] DPolygon polygon

Description: Convert the path to a polygon

The returned polygon is not guaranteed to be non-selfoverlapping. This may happen if the path overlaps itself or contains very short segments.

round=( bool )

Description: Set the 'round ends' flag

[const] DSimplePolygon simple_polygon

Description: Convert the path to a simple polygon

The returned polygon is not guaranteed to be non-selfoverlapping. This may happen if the path overlaps itself or contains very short segments.

[const] string to_s

Description: Convert to a string

[const] DPath transformed( DTrans t )

Description: Transform the path.

Transforms the path with the given transformation. Does not modify the path but returns the transformed path.

t:	The transformation to apply.
returns:	The transformed path.

[const] DPath transformed_cplx( DCplxTrans t )

Description: Transform the path.

Transforms the path with the given complex transformation. Does not modify the path but returns the transformed path.

t:	The transformation to apply.
returns:	The transformed path.

[const] double width

Description: Get the width

width=( double )

Description: Set the width