Class: File_Therion_ScrapPoint

Source Location: /File_Therion-0.4.1/File/Therion/ScrapPoint.php

Class Overview

File_Therion_BasicObject
   |
   --File_Therion_ScrapPoint

Class representing a scrap point definition object.

Author(s):

Benedikt Hallinger <beni at php.net>

Copyright:

2016 Benedikt Hallinger

Variables

Methods

Inherited Variables

Class: File_Therion_BasicObject

File_Therion_BasicObject::$objStack
File_Therion_BasicObject::$_simpledata

Inherited Methods

Class: File_Therion_BasicObject

File_Therion_BasicObject::addComment(): Add a comment.
File_Therion_BasicObject::getData(): Get some simple data of this object.
File_Therion_BasicObject::getOption(): Get option of this object.
File_Therion_BasicObject::getOptionsString(): Generate basic options string.
File_Therion_BasicObject::handleCommonOption(): Handle known options supported by several objects.
File_Therion_BasicObject::setData(): Set some simple data of this object.
File_Therion_BasicObject::setOption(): Set options of this object.
File_Therion_BasicObject::_verify(): Verify basic compliance of item.

Class Details

[line 27]
Class representing a scrap point definition object.

This is a vector graphic element that is used to form a renderable cavemap.

Author: Benedikt Hallinger <beni@php.net>
Copyright: 2016 Benedikt Hallinger
Link: http://pear.php.net/package/File_Therion/
License: LGPLv3

[ Top ]

Class Variables

$_data = array(
'coords' => array(0.0, 0.0),// x, y
'type'=>"")

[line 50]

Basic data elements.

Access: protected

Type:

array

[ Top ]

$_options = array(
        'id'          => "",
        'name'        => "", // only certain types!
        'align'       => "", // only certain types!
        'orientation' => "", // only certain types!
        // todo: there are alot more.
    )

[line 36]

Object options (title, ...).

Var: assoc array
Access: protected

Type:	array
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 62]

File_Therion_ScrapPoint __construct(

$x, 
$y, 
$type, [
$options = array()], string
$id)

Create a new therion ScrapPoint object.

Todo: Restrict naming convention, not all characters are allowed!
Access: public

Parameters:

string	`$id`	—	Name/ID of the drawing object
	`$x`	—
	`$y`	—
	`$type`	—
	`$options`	—

[ Top ]

getCoordinates [line 149]

array getCoordinates(
)

Get scrap coordinates of this point.

Return: Index as following: 0=X, 1=Y
Access: public

[ Top ]

getType [line 196]

string getType(
)

Get point main type.

To get the subtype, use the getOption() method with "subtype" as argument.

Access: public

[ Top ]

getX [line 159]

float getX(
)

Get scrap X coordinate of this point.

Access: public

[ Top ]

getY [line 169]

float getY(
)

Get scrap Y coordinate of this point.

Access: public

[ Top ]

parse [line 81]

File_Therion_ScrapPoint parse(
array
$line)

Parses given Therion_Line-objects into internal data structures.

Return: ScrapPoint object
Todo: implement me
Throws: InvalidArgumentException
Access: public

Parameters:

array $line — File_Therion_Line object forming this object

[ Top ]

setType [line 183]

void setType(
string
$type)

Set main type of point.

To set the subtype, use the setOption() method with "subtype" as argument.

Access: public

Parameters:

string $type —

[ Top ]

setX [line 119]

void setX(
float
$x)

Set X scrap coordinate value of point.

Access: public

Parameters:

float $x —

[ Top ]

setY [line 134]

void setY(
float
$y)

Set Y scrap coordinate value of point.

Access: public

Parameters:

float $y —

[ Top ]

Class: File_Therion_ScrapPoint

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Class: File_Therion_BasicObject

Inherited Methods

Class: File_Therion_BasicObject

Class Details

Class Variables

$_data = array( 'coords' => array(0.0, 0.0),// x, y 'type'=>"")

$_options = array( 'id' => "", 'name' => "", // only certain types! 'align' => "", // only certain types! 'orientation' => "", // only certain types! // todo: there are alot more. )

Method Detail

__construct (Constructor) [line 62]

Parameters:

getCoordinates [line 149]

getType [line 196]

getX [line 159]

getY [line 169]

parse [line 81]

Parameters:

setType [line 183]

Parameters:

setX [line 119]

Parameters:

setY [line 134]

Parameters:

$_data = array(
'coords' => array(0.0, 0.0),// x, y
'type'=>"")

$_options = array(
'id' => "",
'name' => "", // only certain types!
'align' => "", // only certain types!
'orientation' => "", // only certain types!
// todo: there are alot more.
)