agxWire::HighResolutionRange Class Reference

Class to control variable node density along wires through routed nodes. More...

#include <Node.h>

Public Member Functions
	HighResolutionRange ()
	Default constructor.
agx::Real	getEndDistance () const
agx::Real	getNodesPerUnitDistance () const
agx::Real	getStartDistance () const
bool	isActive () const
void	reverse ()
	Reverse range (distances).
void	set (agx::Real startDistance, agx::Real endDistance, agx::Real nodesPerUnitDistance)
	Function to activate the high resolution for a node in a wire.
void	setEndDistance (agx::Real endDistance)
	Assign new end distance.
void	setNodesPerUnitDistance (agx::Real nodesPerUnitDistance)
	Assign new resolution (number of nodes per unit distance).
void	setStartDistance (agx::Real startDistance)
	Assign new start distance.

Protected Attributes
agx::Real	m_endDistance
agx::Real	m_nodesPerUnitDistance
agx::Real	m_startDistance

Detailed Description

Class to control variable node density along wires through routed nodes.

All nodes contain a high resolution range.

Definition at line 423 of file agxWire/Node.h.

Constructor & Destructor Documentation

HighResolutionRange()

agxWire::HighResolutionRange::HighResolutionRange

(

)

Default constructor.

Start distance: 0, end distance: 0, nodes per unit distance: invalid.

Member Function Documentation

getEndDistance()

agx::Real agxWire::HighResolutionRange::getEndDistance

(

)

const

Returns

the end distance parameter

getNodesPerUnitDistance()

agx::Real agxWire::HighResolutionRange::getNodesPerUnitDistance

(

)

const

Returns

the number of nodes per unit distance parameter

getStartDistance()

agx::Real agxWire::HighResolutionRange::getStartDistance

(

)

const

Returns

the start distance parameter

isActive()

bool agxWire::HighResolutionRange::isActive

(

)

const

Returns

true if this node will affect the resolution of the wire the node is on

reverse()

void agxWire::HighResolutionRange::reverse

(

)

Reverse range (distances).

set()

void agxWire::HighResolutionRange::set	(	agx::Real	startDistance,
		agx::Real	endDistance,
		agx::Real	nodesPerUnitDistance
	)

Function to activate the high resolution for a node in a wire.

The wire will use the highest local resolution when updating its resolution.

Parameters

startDistance	- defines a point at distance along the wire from the node where the local resolution starts. (could be +-)
endDistance	- defines a point at distance along the wire from the node where the local resolution ends. (could be +-)
nodesPerUnitDistance	- defines a local resolution within startDistance to endDistance

setEndDistance()

void agxWire::HighResolutionRange::setEndDistance

(

agx::Real

endDistance

)

Assign new end distance.

End distance defines a point at distance along the wire from the node where the local resolution ends. (could be +-)

Parameters

endDistance

- new end distance (valid < current end distance)

Note

Assigning end distance lower than the current start distance will make the range invalid.

setNodesPerUnitDistance()

void agxWire::HighResolutionRange::setNodesPerUnitDistance

(

agx::Real

nodesPerUnitDistance

)

Assign new resolution (number of nodes per unit distance).

Any real value larger than zero is valid. E.g., 0.5 (and unit meters) means one mass node every two meters.

Note

Assigning resolution to less or equal to zero will make the range invalid.

setStartDistance()

void agxWire::HighResolutionRange::setStartDistance

(

agx::Real

startDistance

)

Assign new start distance.

Start distance defines a point at distance along the wire from the node where the local resolution starts. (could be +-)

Parameters

startDistance

- new start distance (valid < current end distance)

Note

Assigning start distance higher than the current end distance will make the range invalid.

Member Data Documentation

m_endDistance

agx::Real agxWire::HighResolutionRange::m_endDistance

protected

Definition at line 504 of file agxWire/Node.h.

m_nodesPerUnitDistance

agx::Real agxWire::HighResolutionRange::m_nodesPerUnitDistance

protected

Definition at line 505 of file agxWire/Node.h.

m_startDistance

agx::Real agxWire::HighResolutionRange::m_startDistance

protected

Definition at line 503 of file agxWire/Node.h.

---

The documentation for this class was generated from the following file:

• agxWire/Node.h